repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
microsoft/PSRule | 2f2e2125c0c85b4f727b540977f8297c520bda6f | 2022-11-12T07:26:16 | schemas/PSRule-options.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to `Warn`, a warning is generated. When set to `Ignore`, no output will be displayed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"initialSessionState": {
"default": "BuiltIn",
"description": "Determines how the initial session state for executing PowerShell code is created. The default is BuiltIn.",
"enum": [
"BuiltIn",
"Minimal"
],
"markdownDescription": "Determines how the initial session state for executing PowerShell code is created. The default is `BuiltIn`.\n- When set to `BuiltIn` all built-in cmdlets are loaded.\n- When set to `Minimal` only cmdlets for hosting PowerShell will be loaded.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninitialsessionstate)",
"title": "Initial Session State",
"type": "string"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is true.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is true.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"ignoreUnchangedPath": {
"default": false,
"description": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed.",
"markdownDescription": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreunchangedpath)",
"title": "Ignore unchanged path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jobSummaryPath": {
"description": "The path to a job summary output file.",
"markdownDescription": "The path to a job summary output file. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjobsummarypath)",
"title": "Job Summary Path",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"baseRef": {
"description": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system.",
"markdownDescription": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositorybaseref)",
"title": "Base Reference",
"type": "string"
},
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule | 98c2513b14d18dccb2f4ee56693caaa36a441d2c | 2022-03-06T23:31:06 | schemas/PSRule-language.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"description": "Rules to exclude by name from the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Rules to include by name in the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"baseline": {
"$ref": "#/definitions/resourceName",
"description": "The name of a baseline to use.",
"markdownDescription": "The name of a baseline to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#rulebaseline)",
"title": "Baseline",
"type": "string"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"properties": {
"obsolete": {
"default": false,
"description": "A common annotation that flags the resource as obsolete.",
"title": "Obsolete",
"type": "boolean"
}
},
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"tags": {
"$ref": "#/definitions/resourceTags"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"resourceTags": {
"additionalProperties": {
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Tag key/ value"
}
],
"description": "Additional indexed key/ value pairs for the resource.",
"title": "Tags",
"type": "object"
},
"rule-v1": {
"description": "A rule resource.",
"markdownDescription": "A rule resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A rule resource.",
"enum": [
"Rule"
],
"markdownDescription": "A rule resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ruleMetadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/ruleSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Rule",
"type": "object"
},
"ruleMetadata": {
"description": "Additional information to identify the resource.",
"properties": {
"alias": {
"description": "Alternative names this resource is known by.",
"items": {
"$ref": "#/definitions/resourceName",
"description": "An alternative name.",
"title": "Alias",
"type": "string"
},
"title": "Aliases",
"type": "array",
"uniqueItems": true
},
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"ref": {
"$ref": "#/definitions/resourceName",
"description": "An optional stable opaque identifier of this resource for lookup. This must be unique if set.",
"title": "Reference"
},
"tags": {
"$ref": "#/definitions/resourceTags"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"ruleSpec": {
"additionalProperties": false,
"description": "The specification for the rule.",
"markdownDescription": "The specification for the rule. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"properties": {
"condition": {
"$ref": "#/definitions/selectorExpression",
"description": "A condition is made up of one or more expressions that will determine if the rule passes or fails.",
"markdownDescription": "A condition is made up of one or more [expressions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/) that will determine if the rule passes or fails. [See help](https://microsoft.github.io/PSRule/v2/authoring/writing-rules/)",
"title": "Condition",
"type": "object"
},
"level": {
"default": "Error",
"description": "If the rule fails, how serious is the result. By default this is set to Error.",
"enum": [
"Error",
"Warning",
"Information"
],
"markdownDescription": "If the rule fails, how serious is the result. By default this is set to `Error`. [See help](https://microsoft.github.io/PSRule/v2/authoring/writing-rules/)",
"title": "Level",
"type": "string"
},
"type": {
"description": "This rule only applies to objects that match the specifies types.",
"items": {
"type": "string"
},
"title": "Type pre-condition",
"type": "array",
"uniqueItems": true
},
"with": {
"description": "This rule only applies to objects that match the specified selectors.",
"items": {
"type": "string"
},
"title": "Selector pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"condition"
],
"title": "Spec",
"type": "object"
},
"selector-v1": {
"description": "A selector resource.",
"markdownDescription": "A selector resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionSetOf"
},
{
"$ref": "#/definitions/selectorConditionSubset"
},
{
"$ref": "#/definitions/selectorConditionCount"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsArray"
},
{
"$ref": "#/definitions/selectorConditionIsBoolean"
},
{
"$ref": "#/definitions/selectorConditionIsDateTime"
},
{
"$ref": "#/definitions/selectorConditionIsInteger"
},
{
"$ref": "#/definitions/selectorConditionIsNumeric"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
},
{
"$ref": "#/definitions/selectorConditionHasSchema"
},
{
"$ref": "#/definitions/selectorConditionVersion"
},
{
"$ref": "#/definitions/selectorConditionHasDefault"
},
{
"$ref": "#/definitions/selectorConditionWithinPath"
},
{
"$ref": "#/definitions/selectorConditionNotWithinPath"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)",
"title": "Case sensitive",
"type": "boolean"
},
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)",
"title": "Contains"
},
"convert": {
"default": false,
"description": "Convert type to string.",
"markdownDescription": "Convert type to string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)",
"title": "Type conversion",
"type": "boolean"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionCount": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"count": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#count)",
"minimum": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type to string.",
"markdownDescription": "Convert type to string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)",
"title": "Type conversion",
"type": "boolean"
},
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive. Only applies to string values.",
"markdownDescription": "Determines if comparing values is case-sensitive. Only applies to string values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type of compared operand.",
"markdownDescription": "Convert type of compared operand. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)",
"title": "Type conversion",
"type": "boolean"
},
"equals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)",
"title": "Equals"
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasDefault": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasdefault)",
"title": "Case sensitive",
"type": "boolean"
},
"hasDefault": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "The field must either not exist or be set to the configured value.",
"markdownDescription": "The field must either not exist or be set to the configured value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasdefault)",
"title": "Has Default"
}
},
"required": [
"hasDefault"
],
"type": "object"
},
"selectorConditionHasSchema": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing schemas is case-sensitive.",
"markdownDescription": "Determines if comparing schemas is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Case sensitive",
"type": "boolean"
},
"hasSchema": {
"default": [],
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"items": {
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"minLength": 1,
"title": "Has schema",
"type": "string"
},
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Has schema",
"type": "array",
"uniqueItems": true
},
"ignoreScheme": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Ignore scheme",
"type": "boolean"
}
},
"required": [
"hasSchema"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"in": {
"description": "Must equal one of the specified values.",
"markdownDescription": "Must equal one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsArray": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isArray": {
"description": "Must be an array type.",
"markdownDescription": "Must be an array type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isarray)",
"title": "Is array",
"type": "boolean"
}
},
"required": [
"isArray"
],
"type": "object"
},
"selectorConditionIsBoolean": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to boolean.",
"markdownDescription": "Convert type to boolean. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isboolean)",
"title": "Type conversion",
"type": "boolean"
},
"isBoolean": {
"description": "Must be a boolean type.",
"markdownDescription": "Must be a boolean type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isboolean)",
"title": "Is boolean",
"type": "boolean"
}
},
"required": [
"isBoolean"
],
"type": "object"
},
"selectorConditionIsDateTime": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to datetime.",
"markdownDescription": "Convert type to datetime. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isdatetime)",
"title": "Type conversion",
"type": "boolean"
},
"isDateTime": {
"description": "Must be a datetime type.",
"markdownDescription": "Must be a datetime type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isdatetime)",
"title": "Is datetime",
"type": "boolean"
}
},
"required": [
"isDateTime"
],
"type": "object"
},
"selectorConditionIsInteger": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to integer.",
"markdownDescription": "Convert type to integer. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isinteger)",
"title": "Type conversion",
"type": "boolean"
},
"isInteger": {
"description": "Must be an integer type.",
"markdownDescription": "Must be an integer type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isinteger)",
"title": "Is integer",
"type": "boolean"
}
},
"required": [
"isInteger"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsNumeric": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to numeric.",
"markdownDescription": "Convert type to numeric. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isnumeric)",
"title": "Type conversion",
"type": "boolean"
},
"isNumeric": {
"description": "Must be a numeric type.",
"markdownDescription": "Must be a numeric type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isnumeric)",
"title": "Is numeric",
"type": "boolean"
}
},
"required": [
"isNumeric"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive. Only applies to string values.",
"markdownDescription": "Determines if comparing values is case-sensitive. Only applies to string values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type of compared operand.",
"markdownDescription": "Convert type of compared operand. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)",
"title": "Type conversion",
"type": "boolean"
},
"notEquals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)",
"title": "Not Equals"
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the specified values.",
"markdownDescription": "Must not equal any of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionNotWithinPath": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notwithinpath)",
"title": "Case sensitive",
"type": "boolean"
},
"notWithinPath": {
"default": [],
"description": "The file path must not exist within the required paths.",
"items": {
"type": "string"
},
"markdownDescription": "The file path must not exist within the required paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notwithinpath)",
"title": "Not Within Path",
"type": "array",
"uniqueItems": true
}
},
"required": [
"notWithinPath"
],
"type": "object"
},
"selectorConditionSetOf": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#setof)",
"title": "Case sensitive",
"type": "boolean"
},
"setOf": {
"description": "Must include all of but only specified values.",
"markdownDescription": "Must include all of but only values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#setof)",
"title": "SetOf",
"type": "array"
}
},
"required": [
"setOf"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type to string.",
"markdownDescription": "Convert type to string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)",
"title": "Type conversion",
"type": "boolean"
},
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorConditionSubset": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Case sensitive",
"type": "boolean"
},
"subset": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Subset",
"type": "array"
},
"unique": {
"default": false,
"description": "Determines if each of the field values must be unique.",
"markdownDescription": "Determines if each of the field values must be unique. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Unique",
"type": "boolean"
}
},
"required": [
"subset"
],
"type": "object"
},
"selectorConditionVersion": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"includePrerelease": {
"default": false,
"description": "Determines if pre-release versions are included. By default, pre-release versions are not included.",
"markdownDescription": "Determines if pre-release versions are included. By default, pre-release versions are not included. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#version)",
"title": "Include pre-release",
"type": "boolean"
},
"version": {
"default": "",
"description": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range.",
"markdownDescription": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#version)",
"title": "Version",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"selectorConditionWithinPath": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#withinpath)",
"title": "Case sensitive",
"type": "boolean"
},
"withinPath": {
"default": [],
"description": "The file path must exist within the required paths.",
"items": {
"type": "string"
},
"markdownDescription": "The file path must exist within the required paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#withinpath)",
"title": "Within Path",
"type": "array",
"uniqueItems": true
}
},
"required": [
"withinPath"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValue": {
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "integer"
}
]
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#allof)",
"title": "All Of",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#anyof)",
"title": "Any Of",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
}
]
},
"selectorPropertiesString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
},
{
"$ref": "#/definitions/selectorPropertyType"
},
{
"$ref": "#/definitions/selectorPropertyName"
},
{
"$ref": "#/definitions/selectorPropertySource"
}
]
},
"selectorPropertyField": {
"properties": {
"field": {
"default": ".",
"description": "The object path of a field to compare.",
"markdownDescription": "The object path of a field to compare. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
},
"selectorPropertyName": {
"properties": {
"name": {
"default": ".",
"description": "The target name of the object.",
"markdownDescription": "The target name of the object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#name)",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
]
},
"selectorPropertySource": {
"properties": {
"source": {
"description": "The source of the object currently being processed by the pipeline.",
"markdownDescription": "The source of the object currently being processed by the pipeline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#source)",
"title": "Source",
"type": "string"
}
},
"required": [
"source"
]
},
"selectorPropertyType": {
"properties": {
"type": {
"default": ".",
"description": "The target type of the object.",
"markdownDescription": "The target type of the object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#type)",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "The specification for a selector.",
"markdownDescription": "The specification for a selector. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"description": "A condition is made up of one or more expressions that will determine if an object is selected by the selector.",
"markdownDescription": "A condition is made up of one or more [expressions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/) that will determine if an object is selected by the selector. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"title": "If",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
},
"suppressionGroup-v1": {
"description": "A PSRule Suppression Group",
"markdownDescription": "A PSRule Suppression Group. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_SuppressionGroups/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule SuppressionGroup resource.",
"enum": [
"SuppressionGroup"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/suppressionGroupSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "SuppressionGroup",
"type": "object"
},
"suppressionGroupSpec": {
"additionalProperties": false,
"description": "PSRule Suppression Group specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"rule": {
"description": "This only applies to rules that match the specified rule names",
"items": {
"type": "string"
},
"title": "Rule pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/rule-v1"
},
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
},
{
"$ref": "#/definitions/suppressionGroup-v1"
}
]
} | MIT | en |
microsoft/PSRule | af6531aa2014566d1b3b55fb6bd1be83c4099cd1 | 2022-01-14T07:57:03 | schemas/PSRule-options.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is `true`.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, and SupportLinks.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, and `SupportLinks`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, and RunInfo.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, and `RunInfo`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"Default"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "number"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputpath)",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule | b05d4f32ffe857b3e57a215122224718fe17030e | 2022-02-06T13:20:02 | schemas/PSRule-language.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"description": "Rules to exclude by name from the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Rules to include by name in the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"baseline": {
"$ref": "#/definitions/resourceName",
"description": "The name of a baseline to use.",
"markdownDescription": "The name of a baseline to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#rulebaseline)",
"title": "Baseline",
"type": "string"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"properties": {
"obsolete": {
"default": false,
"description": "A common annotation that flags the resource as obsolete.",
"title": "Obsolete",
"type": "boolean"
}
},
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"tags": {
"$ref": "#/definitions/resourceTags"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"resourceTags": {
"additionalProperties": {
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Tag key/ value"
}
],
"description": "Additional indexed key/ value pairs for the resource.",
"title": "Tags",
"type": "object"
},
"rule-v1": {
"description": "A rule resource.",
"markdownDescription": "A rule resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A rule resource.",
"enum": [
"Rule"
],
"markdownDescription": "A rule resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ruleMetadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/ruleSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Rule",
"type": "object"
},
"ruleMetadata": {
"description": "Additional information to identify the resource.",
"properties": {
"alias": {
"description": "Alternative names this resource is known by.",
"items": {
"$ref": "#/definitions/resourceName",
"description": "An alternative name.",
"title": "Alias",
"type": "string"
},
"title": "Aliases",
"type": "array",
"uniqueItems": true
},
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"ref": {
"$ref": "#/definitions/resourceName",
"description": "An optional stable opaque identifier of this resource for lookup. This must be unique if set.",
"title": "Reference"
},
"tags": {
"$ref": "#/definitions/resourceTags"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"ruleSpec": {
"additionalProperties": false,
"description": "The specification for the rule.",
"markdownDescription": "The specification for the rule. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"properties": {
"condition": {
"$ref": "#/definitions/selectorExpression",
"description": "A condition is made up of one or more expressions that will determine if the rule passes or fails.",
"markdownDescription": "A condition is made up of one or more [expressions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/) that will determine if the rule passes or fails. [See help](https://microsoft.github.io/PSRule/v2/authoring/writing-rules/)",
"title": "Condition",
"type": "object"
},
"level": {
"default": "Error",
"description": "If the rule fails, how serious is the result. By default this is set to Error.",
"enum": [
"Error",
"Warning",
"Information"
],
"markdownDescription": "If the rule fails, how serious is the result. By default this is set to `Error`. [See help](https://microsoft.github.io/PSRule/v2/authoring/writing-rules/)",
"title": "Level",
"type": "string"
},
"type": {
"description": "This rule only applies to objects that match the specifies types.",
"items": {
"type": "string"
},
"title": "Type pre-condition",
"type": "array",
"uniqueItems": true
},
"with": {
"description": "This rule only applies to objects that match the specified selectors.",
"items": {
"type": "string"
},
"title": "Selector pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"condition"
],
"title": "Spec",
"type": "object"
},
"selector-v1": {
"description": "A selector resource.",
"markdownDescription": "A selector resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionSetOf"
},
{
"$ref": "#/definitions/selectorConditionSubset"
},
{
"$ref": "#/definitions/selectorConditionCount"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsArray"
},
{
"$ref": "#/definitions/selectorConditionIsBoolean"
},
{
"$ref": "#/definitions/selectorConditionIsDateTime"
},
{
"$ref": "#/definitions/selectorConditionIsInteger"
},
{
"$ref": "#/definitions/selectorConditionIsNumeric"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
},
{
"$ref": "#/definitions/selectorConditionHasSchema"
},
{
"$ref": "#/definitions/selectorConditionVersion"
},
{
"$ref": "#/definitions/selectorConditionHasDefault"
},
{
"$ref": "#/definitions/selectorConditionWithinPath"
},
{
"$ref": "#/definitions/selectorConditionNotWithinPath"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)",
"title": "Contains"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionCount": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"count": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#count)",
"minimum": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"equals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)",
"title": "Equals"
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasDefault": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasdefault)",
"title": "Case sensitive",
"type": "boolean"
},
"hasDefault": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "The field must either not exist or be set to the configured value.",
"markdownDescription": "The field must either not exist or be set to the configured value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasdefault)",
"title": "Has Default"
}
},
"required": [
"hasDefault"
],
"type": "object"
},
"selectorConditionHasSchema": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing schemas is case-sensitive.",
"markdownDescription": "Determines if comparing schemas is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Case sensitive",
"type": "boolean"
},
"hasSchema": {
"default": [],
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"items": {
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"minLength": 1,
"title": "Has schema",
"type": "string"
},
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Has schema",
"type": "array",
"uniqueItems": true
},
"ignoreScheme": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Ignore scheme",
"type": "boolean"
}
},
"required": [
"hasSchema"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"in": {
"description": "Must equal one of the specified values.",
"markdownDescription": "Must equal one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsArray": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isArray": {
"description": "Must be an array type.",
"markdownDescription": "Must be an array type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isarray)",
"title": "Is array",
"type": "boolean"
}
},
"required": [
"isArray"
],
"type": "object"
},
"selectorConditionIsBoolean": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to boolean.",
"markdownDescription": "Convert type to boolean. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isboolean)",
"title": "Type conversion",
"type": "boolean"
},
"isBoolean": {
"description": "Must be a boolean type.",
"markdownDescription": "Must be a boolean type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isboolean)",
"title": "Is boolean",
"type": "boolean"
}
},
"required": [
"isBoolean"
],
"type": "object"
},
"selectorConditionIsDateTime": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to datetime.",
"markdownDescription": "Convert type to datetime. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isdatetime)",
"title": "Type conversion",
"type": "boolean"
},
"isDateTime": {
"description": "Must be a datetime type.",
"markdownDescription": "Must be a datetime type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isdatetime)",
"title": "Is datetime",
"type": "boolean"
}
},
"required": [
"isDateTime"
],
"type": "object"
},
"selectorConditionIsInteger": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to integer.",
"markdownDescription": "Convert type to integer. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isinteger)",
"title": "Type conversion",
"type": "boolean"
},
"isInteger": {
"description": "Must be an integer type.",
"markdownDescription": "Must be an integer type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isinteger)",
"title": "Is integer",
"type": "boolean"
}
},
"required": [
"isInteger"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsNumeric": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to numeric.",
"markdownDescription": "Convert type to numeric. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isnumeric)",
"title": "Type conversion",
"type": "boolean"
},
"isNumeric": {
"description": "Must be a numeric type.",
"markdownDescription": "Must be a numeric type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isnumeric)",
"title": "Is numeric",
"type": "boolean"
}
},
"required": [
"isNumeric"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notEquals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)",
"title": "Not Equals"
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the specified values.",
"markdownDescription": "Must not equal any of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionNotWithinPath": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notwithinpath)",
"title": "Case sensitive",
"type": "boolean"
},
"notWithinPath": {
"default": [],
"description": "The file path must not exist within the required paths.",
"items": {
"type": "string"
},
"markdownDescription": "The file path must not exist within the required paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notwithinpath)",
"title": "Not Within Path",
"type": "array",
"uniqueItems": true
}
},
"required": [
"notWithinPath"
],
"type": "object"
},
"selectorConditionSetOf": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#setof)",
"title": "Case sensitive",
"type": "boolean"
},
"setOf": {
"description": "Must include all of but only specified values.",
"markdownDescription": "Must include all of but only values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#setof)",
"title": "SetOf",
"type": "array"
}
},
"required": [
"setOf"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorConditionSubset": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Case sensitive",
"type": "boolean"
},
"subset": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Subset",
"type": "array"
},
"unique": {
"default": false,
"description": "Determines if each of the field values must be unique.",
"markdownDescription": "Determines if each of the field values must be unique. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Unique",
"type": "boolean"
}
},
"required": [
"subset"
],
"type": "object"
},
"selectorConditionVersion": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"includePrerelease": {
"default": false,
"description": "Determines if pre-release versions are included. By default, pre-release versions are not included.",
"markdownDescription": "Determines if pre-release versions are included. By default, pre-release versions are not included. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#version)",
"title": "Include pre-release",
"type": "boolean"
},
"version": {
"default": "",
"description": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range.",
"markdownDescription": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#version)",
"title": "Version",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"selectorConditionWithinPath": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#withinpath)",
"title": "Case sensitive",
"type": "boolean"
},
"withinPath": {
"default": [],
"description": "The file path must exist within the required paths.",
"items": {
"type": "string"
},
"markdownDescription": "The file path must exist within the required paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#withinpath)",
"title": "Within Path",
"type": "array",
"uniqueItems": true
}
},
"required": [
"withinPath"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValue": {
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "integer"
}
]
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#allof)",
"title": "All Of",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#anyof)",
"title": "Any Of",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
}
]
},
"selectorPropertiesString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
},
{
"$ref": "#/definitions/selectorPropertyType"
},
{
"$ref": "#/definitions/selectorPropertyName"
},
{
"$ref": "#/definitions/selectorPropertySource"
}
]
},
"selectorPropertyField": {
"properties": {
"field": {
"default": ".",
"description": "The object path of a field to compare.",
"markdownDescription": "The object path of a field to compare. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
},
"selectorPropertyName": {
"properties": {
"name": {
"default": ".",
"description": "The target name of the object.",
"markdownDescription": "The target name of the object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#name)",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
]
},
"selectorPropertySource": {
"properties": {
"source": {
"description": "The source of the object currently being processed by the pipeline.",
"markdownDescription": "The source of the object currently being processed by the pipeline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#source)",
"title": "Source",
"type": "string"
}
},
"required": [
"source"
]
},
"selectorPropertyType": {
"properties": {
"type": {
"default": ".",
"description": "The target type of the object.",
"markdownDescription": "The target type of the object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#type)",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "The specification for a selector.",
"markdownDescription": "The specification for a selector. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"description": "A condition is made up of one or more expressions that will determine if an object is selected by the selector.",
"markdownDescription": "A condition is made up of one or more [expressions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/) that will determine if an object is selected by the selector. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"title": "If",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
},
"suppressionGroup-v1": {
"description": "A PSRule Suppression Group",
"markdownDescription": "A PSRule Suppression Group. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_SuppressionGroups/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule SuppressionGroup resource.",
"enum": [
"SuppressionGroup"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/suppressionGroupSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "SuppressionGroup",
"type": "object"
},
"suppressionGroupSpec": {
"additionalProperties": false,
"description": "PSRule Suppression Group specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"rule": {
"description": "This only applies to rules that match the specified rule names",
"items": {
"type": "string"
},
"title": "Rule pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/rule-v1"
},
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
},
{
"$ref": "#/definitions/suppressionGroup-v1"
}
]
} | MIT | en |
microsoft/PSRule | 4bab75f1ff19babecf0224ae7c88a434e5f8cf6b | 2022-08-18T07:26:25 | schemas/PSRule-options.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to `Warn`, a warning is generated. When set to `Ignore`, no output will be displayed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is `true`.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is `true`.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule | ad5b12bb7aa20b0a3f081364aaa77176c1597855 | 2023-06-03T19:27:42 | schemas/PSRule-options.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-option": {
"additionalProperties": false,
"description": "Options that configure baselines.",
"properties": {
"group": {
"additionalProperties": {
"description": "Maps a group name to a baseline.",
"title": "Group mapping",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Group}": "${2:Baseline}"
},
"label": "Baseline group"
}
],
"description": "Configure baseline group names.",
"title": "Baseline group",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_AKS_CLUSTER_MINIMUM_VERSION": {
"default": "1.25.4",
"description": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified.",
"markdownDescription": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-rules/#aks-minimum-kubernetes-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "AKS cluster minimum version",
"type": "string"
},
"AZURE_BICEP_CHECK_TOOL": {
"default": false,
"description": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to true.",
"markdownDescription": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to `true`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#checking-bicep-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Checking Bicep Tool",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_BICEP_MINIMUM_VERSION": {
"default": "0.4.451",
"description": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is 0.4.451.",
"markdownDescription": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is `0.4.451`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#configuring-minimum-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep Minimum Version",
"type": "string"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReference": {
"default": "Warn",
"description": "Determines how to handle when an alias to a resource is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces aliasReferenceWarning. You do not need to configure both options. If aliasReferenceWarning is configured, it will override aliasReference with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle when an alias to a resource is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `aliasReferenceWarning`. You do not need to configure both options. If `aliasReferenceWarning` is configured, it will override `aliasReference` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreference)",
"title": "Alias references",
"type": "string"
},
"aliasReferenceWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases | DEPRECATED",
"type": "boolean"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown.\n\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"inconclusiveWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules | DEPRECATED",
"type": "boolean"
},
"initialSessionState": {
"default": "BuiltIn",
"description": "Determines how the initial session state for executing PowerShell code is created. The default is BuiltIn.",
"enum": [
"BuiltIn",
"Minimal"
],
"markdownDescription": "Determines how the initial session state for executing PowerShell code is created. The default is `BuiltIn`.\n- When set to `BuiltIn` all built-in cmdlets are loaded.\n- When set to `Minimal` only cmdlets for hosting PowerShell will be loaded.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninitialsessionstate)",
"title": "Initial Session State",
"type": "string"
},
"invariantCulture": {
"default": "Warn",
"description": "Determines how to report when an invariant culture is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces invariantCultureWarning. You do not need to configure both options. If invariantCultureWarning is configured, it will override invariantCulture with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report when an invariant culture is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `invariantCultureWarning`. You do not need to configure both options. If `invariantCultureWarning` is configured, it will override `invariantCulture` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculture)",
"title": "Invariant culture",
"type": "string"
},
"invariantCultureWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warning when invariant culture is used. The default is true.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture | DEPRECATED",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects | DEPRECATED",
"type": "boolean"
},
"ruleExcluded": {
"default": "Ignore",
"description": "Determines how to handle excluded rules. Regardless of the value, excluded rules are ignored. By default, rules are excluded silently. When set to Error, an error is thrown. When set to Warn, a warning is generated. When set to Debug, a message is written to the debug log.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle excluded rules.\n\nRegardless of the value, excluded rules are ignored. By default, rules are excluded silently.\n\n- When set to `Error`, an error is thrown.\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleexcluded)",
"title": "Rule excluded",
"type": "string"
},
"ruleInconclusive": {
"default": "Warn",
"description": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces inconclusiveWarning. You do not need to configure both options. If inconclusiveWarning is configured, it will override ruleInconclusive with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `inconclusiveWarning`. You do not need to configure both options. If `inconclusiveWarning` is configured, it will override `ruleInconclusive` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleinconclusive)",
"title": "Inconclusive rules",
"type": "string"
},
"ruleSuppressed": {
"default": "Warn",
"description": "Determines how to handle suppressed rules. Regardless of the value, a suppressed rule is ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces suppressedRuleWarning. You do not need to configure both options. If suppressedRuleWarning is configured, it will override ruleSuppressed with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle suppressed rules.\n\nRegardless of the value, a suppressed rule is ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `suppressedRuleWarning`. You do not need to configure both options. If `suppressedRuleWarning` is configured, it will override `ruleSuppressed` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionrulesuppressed)",
"title": "Rule suppressed",
"type": "string"
},
"suppressedRuleWarning": {
"default": true,
"deprecated": true,
"description": "This option has been deprecated and will be removed from v3 in favor of ruleSuppressed. Enable or disable warnings for suppressed rules. The default is true.",
"markdownDescription": "This option has been deprecated and will be removed from v3 in favor of `ruleSuppressed`.\n\nEnable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules | DEPRECATED",
"type": "boolean"
},
"suppressionGroupExpired": {
"default": "Warn",
"description": "Determines how to handle expired suppression groups. Regardless of the value, an expired suppression group will be ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle expired suppression groups.\n\nRegardless of the value, an expired suppression group will be ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressiongroupexpired)",
"title": "Expired suppression groups",
"type": "string"
},
"unprocessedObject": {
"default": "Warn",
"description": "Determines how to report objects that are not processed by any rule. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces notProcessedWarning. You do not need to configure both options. If notProcessedWarning is configured, it will override unprocessedObject with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report objects that are not processed by any rule. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `notProcessedWarning`. You do not need to configure both options. If `notProcessedWarning` is configured, it will override `unprocessedObject` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionunprocessedobject)",
"title": "Unprocessed object",
"type": "string"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"ignoreUnchangedPath": {
"default": false,
"description": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed.",
"markdownDescription": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreunchangedpath)",
"title": "Ignore unchanged path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"baseline": {
"$ref": "#/definitions/baseline-option",
"type": "object"
},
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jobSummaryPath": {
"description": "The path to a job summary output file.",
"markdownDescription": "The path to a job summary output file. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjobsummarypath)",
"title": "Job Summary Path",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"baseRef": {
"description": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system.",
"markdownDescription": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositorybaseref)",
"title": "Base Reference",
"type": "string"
},
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "PSRule options configuration file.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule | 1d766fcdebd6b67b833bf1df7f74e52dac0c0e52 | 2021-09-01T16:03:41 | schemas/PSRule-options.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"oneOf": [
{
"$ref": "#/definitions/execution-option"
}
],
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"oneOf": [
{
"$ref": "#/definitions/input-option"
}
],
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, and SupportLinks.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, and `SupportLinks`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, and RunInfo.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, and `RunInfo`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"Default"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputformat)",
"title": "Output format",
"type": "string"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputpath)",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"title": "Required modules",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Specifies rules to exclude by name.",
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Optionally filter to rules by name.",
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule | bb41e561ec4052cec388c75f77cd7da60a02bc85 | 2023-07-16T16:47:31 | schemas/PSRule-options.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-option": {
"additionalProperties": false,
"description": "Options that configure baselines.",
"properties": {
"group": {
"additionalProperties": {
"description": "Maps a group name to a baseline.",
"title": "Group mapping",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Group}": "${2:Baseline}"
},
"label": "Baseline group"
}
],
"description": "Configure baseline group names.",
"title": "Baseline group",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_AKS_CLUSTER_MINIMUM_VERSION": {
"default": "1.25.4",
"description": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified.",
"markdownDescription": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-rules/#aks-minimum-kubernetes-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "AKS cluster minimum version",
"type": "string"
},
"AZURE_BICEP_CHECK_TOOL": {
"default": false,
"description": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to true.",
"markdownDescription": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to `true`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#checking-bicep-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Checking Bicep Tool",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_BICEP_MINIMUM_VERSION": {
"default": "0.4.451",
"description": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is 0.4.451.",
"markdownDescription": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is `0.4.451`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#configuring-minimum-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep Minimum Version",
"type": "string"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReference": {
"default": "Warn",
"description": "Determines how to handle when an alias to a resource is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces aliasReferenceWarning. You do not need to configure both options. If aliasReferenceWarning is configured, it will override aliasReference with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle when an alias to a resource is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `aliasReferenceWarning`. You do not need to configure both options. If `aliasReferenceWarning` is configured, it will override `aliasReference` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreference)",
"title": "Alias references",
"type": "string"
},
"aliasReferenceWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases | DEPRECATED",
"type": "boolean"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown.\n\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"hashAlgorithm": {
"default": "SHA512",
"description": "Configures the hashing algorithm used by the PSRule runtime. By default, SHA512 is used.",
"enum": [
"SHA512",
"SHA384",
"SHA256"
],
"markdownDescription": "Configures the hashing algorithm used by the PSRule runtime.\n\nBy default, `SHA512` is used.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionhashalgorithm)",
"title": "Hash Algorithm",
"type": "string"
},
"inconclusiveWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules | DEPRECATED",
"type": "boolean"
},
"initialSessionState": {
"default": "BuiltIn",
"description": "Determines how the initial session state for executing PowerShell code is created. The default is BuiltIn.",
"enum": [
"BuiltIn",
"Minimal"
],
"markdownDescription": "Determines how the initial session state for executing PowerShell code is created. The default is `BuiltIn`.\n- When set to `BuiltIn` all built-in cmdlets are loaded.\n- When set to `Minimal` only cmdlets for hosting PowerShell will be loaded.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninitialsessionstate)",
"title": "Initial Session State",
"type": "string"
},
"invariantCulture": {
"default": "Warn",
"description": "Determines how to report when an invariant culture is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces invariantCultureWarning. You do not need to configure both options. If invariantCultureWarning is configured, it will override invariantCulture with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report when an invariant culture is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `invariantCultureWarning`. You do not need to configure both options. If `invariantCultureWarning` is configured, it will override `invariantCulture` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculture)",
"title": "Invariant culture",
"type": "string"
},
"invariantCultureWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warning when invariant culture is used. The default is true.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture | DEPRECATED",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects | DEPRECATED",
"type": "boolean"
},
"ruleExcluded": {
"default": "Ignore",
"description": "Determines how to handle excluded rules. Regardless of the value, excluded rules are ignored. By default, rules are excluded silently. When set to Error, an error is thrown. When set to Warn, a warning is generated. When set to Debug, a message is written to the debug log.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle excluded rules.\n\nRegardless of the value, excluded rules are ignored. By default, rules are excluded silently.\n\n- When set to `Error`, an error is thrown.\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleexcluded)",
"title": "Rule excluded",
"type": "string"
},
"ruleInconclusive": {
"default": "Warn",
"description": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces inconclusiveWarning. You do not need to configure both options. If inconclusiveWarning is configured, it will override ruleInconclusive with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `inconclusiveWarning`. You do not need to configure both options. If `inconclusiveWarning` is configured, it will override `ruleInconclusive` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleinconclusive)",
"title": "Inconclusive rules",
"type": "string"
},
"ruleSuppressed": {
"default": "Warn",
"description": "Determines how to handle suppressed rules. Regardless of the value, a suppressed rule is ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces suppressedRuleWarning. You do not need to configure both options. If suppressedRuleWarning is configured, it will override ruleSuppressed with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle suppressed rules.\n\nRegardless of the value, a suppressed rule is ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `suppressedRuleWarning`. You do not need to configure both options. If `suppressedRuleWarning` is configured, it will override `ruleSuppressed` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionrulesuppressed)",
"title": "Rule suppressed",
"type": "string"
},
"suppressedRuleWarning": {
"default": true,
"deprecated": true,
"description": "This option has been deprecated and will be removed from v3 in favor of ruleSuppressed. Enable or disable warnings for suppressed rules. The default is true.",
"markdownDescription": "This option has been deprecated and will be removed from v3 in favor of `ruleSuppressed`.\n\nEnable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules | DEPRECATED",
"type": "boolean"
},
"suppressionGroupExpired": {
"default": "Warn",
"description": "Determines how to handle expired suppression groups. Regardless of the value, an expired suppression group will be ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle expired suppression groups.\n\nRegardless of the value, an expired suppression group will be ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressiongroupexpired)",
"title": "Expired suppression groups",
"type": "string"
},
"unprocessedObject": {
"default": "Warn",
"description": "Determines how to report objects that are not processed by any rule. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces notProcessedWarning. You do not need to configure both options. If notProcessedWarning is configured, it will override unprocessedObject with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report objects that are not processed by any rule. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `notProcessedWarning`. You do not need to configure both options. If `notProcessedWarning` is configured, it will override `unprocessedObject` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionunprocessedobject)",
"title": "Unprocessed object",
"type": "string"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"ignoreUnchangedPath": {
"default": false,
"description": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed.",
"markdownDescription": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreunchangedpath)",
"title": "Ignore unchanged path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"baseline": {
"$ref": "#/definitions/baseline-option",
"type": "object"
},
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jobSummaryPath": {
"description": "The path to a job summary output file.",
"markdownDescription": "The path to a job summary output file. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjobsummarypath)",
"title": "Job Summary Path",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"baseRef": {
"description": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system.",
"markdownDescription": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositorybaseref)",
"title": "Base Reference",
"type": "string"
},
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "PSRule options configuration file.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule | 838ad1386d67b63e7c80e141e1b52016e7481c11 | 2021-11-08T13:38:34 | schemas/PSRule-language.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"baseline": {
"$ref": "#/definitions/rule-names",
"description": "The name of a baseline to use.",
"markdownDescription": "The name of a baseline to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#rulebaseline)",
"title": "Baseline",
"type": "string"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"title": "Annotations",
"type": "object"
},
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"title": "Tags",
"type": "object"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-v1": {
"description": "A PSRule Rule.",
"markdownDescription": "A PSRule Rule. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Rules.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Rule resource.",
"enum": [
"Rule"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/ruleSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Rule",
"type": "object"
},
"ruleSpec": {
"additionalProperties": false,
"description": "PSRule rule specification.",
"properties": {
"condition": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"type": {
"description": "This rule only applies to objects that match the specifies types.",
"items": {
"type": "string"
},
"title": "Type pre-condition",
"type": "array",
"uniqueItems": true
},
"with": {
"description": "This rule only applies to objects that match the specified selectors.",
"items": {
"type": "string"
},
"title": "Selector pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"condition"
],
"title": "Spec",
"type": "object"
},
"selector-v1": {
"description": "A PSRule Selector.",
"markdownDescription": "A PSRule Selector. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionSetOf"
},
{
"$ref": "#/definitions/selectorConditionSubset"
},
{
"$ref": "#/definitions/selectorConditionCount"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#contains)",
"title": "Contains"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionCount": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"count": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#count)",
"minimum": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"equals": {
"oneOf": [
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "string"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "integer"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "boolean"
}
]
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"in": {
"description": "Must equal one the values.",
"markdownDescription": "Must equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notEquals": {
"oneOf": [
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "string"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "integer"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "boolean"
}
]
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the values.",
"markdownDescription": "Must not equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionSetOf": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#setof)",
"title": "Case sensitive",
"type": "boolean"
},
"setOf": {
"description": "Must include all of but only specified values.",
"markdownDescription": "Must include all of but only values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#setof)",
"title": "SetOf",
"type": "array"
}
},
"required": [
"setOf"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorConditionSubset": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Case sensitive",
"type": "boolean"
},
"subset": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Subset",
"type": "array"
},
"unique": {
"default": false,
"description": "Determines each of the field values must be unique.",
"markdownDescription": "Determines each of the field values must be unique. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Unique",
"type": "boolean"
}
},
"required": [
"subset"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#allof)",
"title": "AllOf",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#anyof)",
"title": "AnyOf",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
}
]
},
"selectorPropertiesString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
},
{
"$ref": "#/definitions/selectorPropertyType"
},
{
"$ref": "#/definitions/selectorPropertyName"
}
]
},
"selectorPropertyField": {
"properties": {
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
},
"selectorPropertyName": {
"properties": {
"name": {
"default": ".",
"description": "The target name of the object.",
"markdownDescription": "The target name of the object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#name)",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
]
},
"selectorPropertyType": {
"properties": {
"type": {
"default": ".",
"description": "The target type of the object.",
"markdownDescription": "The target type of the object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#type)",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "PSRule selector specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/rule-v1"
},
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
}
]
} | MIT | en |
microsoft/PSRule | 5f667ff501f0d111887537e31ffb4a8447a085c5 | 2022-01-19T09:02:02 | schemas/PSRule-options.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is `true`.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is `true`.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, and SupportLinks.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, and `SupportLinks`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, and RunInfo.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, and `RunInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"Default"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "number"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule | 1ccaa73a51e76d3442a925f767fb50b392fd9315 | 2024-01-14T23:33:57 | schemas/PSRule-lock.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "A schema for the PSRule lock file.",
"properties": {
"modules": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"version": {
"description": "The version of the module to use.",
"title": "Module version",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"description": "A list of specific module versions for PSRule to restore.",
"title": "Modules",
"type": "object"
},
"version": {
"description": "The version of the lock file schema.",
"enum": [
1
],
"title": "Version",
"type": "integer"
}
},
"required": [
"version",
"modules"
],
"title": "PSRule lock",
"type": "object"
} | MIT | en |
microsoft/PSRule | 1608e046b5b44b40bc8e9f52875dd331751522bd | 2023-08-25T06:42:38 | schemas/PSRule-options.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-option": {
"additionalProperties": false,
"description": "Options that configure baselines.",
"properties": {
"group": {
"additionalProperties": {
"description": "Maps a group name to a baseline.",
"title": "Group mapping",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Group}": "${2:Baseline}"
},
"label": "Baseline group"
}
],
"description": "Configure baseline group names.",
"title": "Baseline group",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_AKS_CLUSTER_MINIMUM_VERSION": {
"default": "1.25.4",
"description": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified.",
"markdownDescription": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-rules/#aks-minimum-kubernetes-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "AKS cluster minimum version",
"type": "string"
},
"AZURE_BICEP_CHECK_TOOL": {
"default": false,
"description": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to true.",
"markdownDescription": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to `true`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#checking-bicep-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Checking Bicep Tool",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_BICEP_MINIMUM_VERSION": {
"default": "0.4.451",
"description": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is 0.4.451.",
"markdownDescription": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is `0.4.451`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#configuring-minimum-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep Minimum Version",
"type": "string"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReference": {
"default": "Warn",
"description": "Determines how to handle when an alias to a resource is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle when an alias to a resource is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreference)",
"title": "Alias references",
"type": "string"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown.\n\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"hashAlgorithm": {
"default": "SHA512",
"description": "Configures the hashing algorithm used by the PSRule runtime. By default, SHA512 is used.",
"enum": [
"SHA512",
"SHA384",
"SHA256"
],
"markdownDescription": "Configures the hashing algorithm used by the PSRule runtime.\n\nBy default, `SHA512` is used.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionhashalgorithm)",
"title": "Hash Algorithm",
"type": "string"
},
"initialSessionState": {
"default": "BuiltIn",
"description": "Determines how the initial session state for executing PowerShell code is created. The default is BuiltIn.",
"enum": [
"BuiltIn",
"Minimal"
],
"markdownDescription": "Determines how the initial session state for executing PowerShell code is created. The default is `BuiltIn`.\n- When set to `BuiltIn` all built-in cmdlets are loaded.\n- When set to `Minimal` only cmdlets for hosting PowerShell will be loaded.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninitialsessionstate)",
"title": "Initial Session State",
"type": "string"
},
"invariantCulture": {
"default": "Warn",
"description": "Determines how to report when an invariant culture is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report when an invariant culture is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculture)",
"title": "Invariant culture",
"type": "string"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"ruleExcluded": {
"default": "Ignore",
"description": "Determines how to handle excluded rules. Regardless of the value, excluded rules are ignored. By default, rules are excluded silently. When set to Error, an error is thrown. When set to Warn, a warning is generated. When set to Debug, a message is written to the debug log.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle excluded rules.\n\nRegardless of the value, excluded rules are ignored. By default, rules are excluded silently.\n\n- When set to `Error`, an error is thrown.\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleexcluded)",
"title": "Rule excluded",
"type": "string"
},
"ruleInconclusive": {
"default": "Warn",
"description": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleinconclusive)",
"title": "Inconclusive rules",
"type": "string"
},
"ruleSuppressed": {
"default": "Warn",
"description": "Determines how to handle suppressed rules. Regardless of the value, a suppressed rule is ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle suppressed rules.\n\nRegardless of the value, a suppressed rule is ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionrulesuppressed)",
"title": "Rule suppressed",
"type": "string"
},
"suppressionGroupExpired": {
"default": "Warn",
"description": "Determines how to handle expired suppression groups. Regardless of the value, an expired suppression group will be ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle expired suppression groups.\n\nRegardless of the value, an expired suppression group will be ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressiongroupexpired)",
"title": "Expired suppression groups",
"type": "string"
},
"unprocessedObject": {
"default": "Warn",
"description": "Determines how to report objects that are not processed by any rule. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report objects that are not processed by any rule. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionunprocessedobject)",
"title": "Unprocessed object",
"type": "string"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"ignoreUnchangedPath": {
"default": false,
"description": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed.",
"markdownDescription": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreunchangedpath)",
"title": "Ignore unchanged path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"baseline": {
"$ref": "#/definitions/baseline-option",
"type": "object"
},
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jobSummaryPath": {
"description": "The path to a job summary output file.",
"markdownDescription": "The path to a job summary output file. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjobsummarypath)",
"title": "Job Summary Path",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"baseRef": {
"description": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system.",
"markdownDescription": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositorybaseref)",
"title": "Base Reference",
"type": "string"
},
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "PSRule options configuration file.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule | 09b661c9d04b3f71dc2511a372989b25a23fda24 | 2022-06-19T07:48:44 | schemas/PSRule-options.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is `true`.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is `true`.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"url": {
"description": "The URL to the repository.",
"markdownDescription": "The URL to the repository.",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule | d8ddcf9e168305e5575f91009cdc8ae27a142709 | 2022-01-16T12:37:24 | schemas/PSRule-language.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"description": "Rules to exclude by name from the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Rules to include by name in the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"baseline": {
"$ref": "#/definitions/resourceName",
"description": "The name of a baseline to use.",
"markdownDescription": "The name of a baseline to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#rulebaseline)",
"title": "Baseline",
"type": "string"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"properties": {
"obsolete": {
"default": false,
"description": "A common annotation that flags the resource as obsolete.",
"title": "Obsolete",
"type": "boolean"
}
},
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Tag key/ value"
}
],
"title": "Tags",
"type": "object"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-v1": {
"description": "A PSRule Rule.",
"markdownDescription": "A PSRule Rule. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Rules.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Rule resource.",
"enum": [
"Rule"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ruleMetadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/ruleSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Rule",
"type": "object"
},
"ruleMetadata": {
"description": "Additional information to identify the resource.",
"properties": {
"alias": {
"description": "Alternative names this resource is known by.",
"items": {
"$ref": "#/definitions/resourceName",
"description": "An alternative name.",
"title": "Alias",
"type": "string"
},
"title": "Aliases",
"type": "array",
"uniqueItems": true
},
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"ref": {
"$ref": "#/definitions/resourceName",
"description": "An optional stable opaque identifier of this resource for lookup. This must be unique if set.",
"title": "Reference"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Tag key/ value"
}
],
"title": "Tags",
"type": "object"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"ruleSpec": {
"additionalProperties": false,
"description": "PSRule rule specification.",
"properties": {
"condition": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"type": {
"description": "This rule only applies to objects that match the specifies types.",
"items": {
"type": "string"
},
"title": "Type pre-condition",
"type": "array",
"uniqueItems": true
},
"with": {
"description": "This rule only applies to objects that match the specified selectors.",
"items": {
"type": "string"
},
"title": "Selector pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"condition"
],
"title": "Spec",
"type": "object"
},
"selector-v1": {
"description": "A PSRule Selector.",
"markdownDescription": "A PSRule Selector. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionSetOf"
},
{
"$ref": "#/definitions/selectorConditionSubset"
},
{
"$ref": "#/definitions/selectorConditionCount"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
},
{
"$ref": "#/definitions/selectorConditionHasSchema"
},
{
"$ref": "#/definitions/selectorConditionVersion"
},
{
"$ref": "#/definitions/selectorConditionHasDefault"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#contains)",
"title": "Contains"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionCount": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"count": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#count)",
"minimum": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"equals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals"
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasDefault": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasdefault)",
"title": "Case sensitive",
"type": "boolean"
},
"hasDefault": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "The field must either not exist or be set to the configured value.",
"markdownDescription": "The field must either not exist or be set to the configured value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasdefault)",
"title": "Has Default"
}
},
"required": [
"hasDefault"
],
"type": "object"
},
"selectorConditionHasSchema": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing schemas is case-sensitive.",
"markdownDescription": "Determines if comparing schemas is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"title": "Case sensitive",
"type": "boolean"
},
"hasSchema": {
"default": [],
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"items": {
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"minLength": 1,
"title": "Has schema",
"type": "string"
},
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"title": "Has schema",
"type": "array",
"uniqueItems": true
},
"ignoreScheme": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"title": "Ignore scheme",
"type": "boolean"
}
},
"required": [
"hasSchema"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"in": {
"description": "Must equal one the values.",
"markdownDescription": "Must equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notEquals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals"
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the values.",
"markdownDescription": "Must not equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionSetOf": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#setof)",
"title": "Case sensitive",
"type": "boolean"
},
"setOf": {
"description": "Must include all of but only specified values.",
"markdownDescription": "Must include all of but only values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#setof)",
"title": "SetOf",
"type": "array"
}
},
"required": [
"setOf"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorConditionSubset": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Case sensitive",
"type": "boolean"
},
"subset": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Subset",
"type": "array"
},
"unique": {
"default": false,
"description": "Determines if each of the field values must be unique.",
"markdownDescription": "Determines if each of the field values must be unique. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Unique",
"type": "boolean"
}
},
"required": [
"subset"
],
"type": "object"
},
"selectorConditionVersion": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"includePrerelease": {
"default": false,
"description": "Determines if pre-release versions are included. By default, pre-release versions are not included.",
"markdownDescription": "Determines if pre-release versions are included. By default, pre-release versions are not included. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#version)",
"title": "Include pre-release",
"type": "boolean"
},
"version": {
"default": "",
"description": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range.",
"markdownDescription": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#version)",
"title": "Version",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValue": {
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "integer"
}
]
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#allof)",
"title": "All Of",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#anyof)",
"title": "Any Of",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
}
]
},
"selectorPropertiesString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
},
{
"$ref": "#/definitions/selectorPropertyType"
},
{
"$ref": "#/definitions/selectorPropertyName"
}
]
},
"selectorPropertyField": {
"properties": {
"field": {
"default": ".",
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
},
"selectorPropertyName": {
"properties": {
"name": {
"default": ".",
"description": "The target name of the object.",
"markdownDescription": "The target name of the object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#name)",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
]
},
"selectorPropertyType": {
"properties": {
"type": {
"default": ".",
"description": "The target type of the object.",
"markdownDescription": "The target type of the object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#type)",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "PSRule selector specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
},
"suppressionGroup-v1": {
"description": "A PSRule Suppression Group",
"markdownDescription": "A PSRule Suppression Group. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_SuppressionGroups/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule SuppressionGroup resource.",
"enum": [
"SuppressionGroup"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/suppressionGroupSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "SuppressionGroup",
"type": "object"
},
"suppressionGroupSpec": {
"additionalProperties": false,
"description": "PSRule Suppression Group specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"rule": {
"description": "This only applies to rules that match the specified rule names",
"items": {
"type": "string"
},
"title": "Rule pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/rule-v1"
},
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
},
{
"$ref": "#/definitions/suppressionGroup-v1"
}
]
} | MIT | en |
microsoft/PSRule | cfd2a8b997c7662e6ff0f79c084f4d1eb3f1be3c | 2021-10-06T05:39:07 | schemas/PSRule-options.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"oneOf": [
{
"$ref": "#/definitions/execution-option"
}
],
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"oneOf": [
{
"$ref": "#/definitions/input-option"
}
],
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, and SupportLinks.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, and `SupportLinks`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, and RunInfo.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, and `RunInfo`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"Default"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "number"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputpath)",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"title": "Required modules",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Specifies rules to exclude by name.",
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Optionally filter to rules by name.",
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule | d8ddcf9e168305e5575f91009cdc8ae27a142709 | 2022-01-16T12:37:24 | schemas/PSRule-resources.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A schema for PSRule resources.",
"items": {
"anyOf": [
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/rule-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/baseline-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/moduleConfig-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/selector-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/suppressionGroup-v1"
}
]
},
"title": "PSRule resources",
"type": "array"
} | MIT | en |
microsoft/PSRule | 48f1d0f878daa4a5f68d533d32c61c8e748ed155 | 2022-01-29T08:02:14 | schemas/PSRule-language.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"description": "Rules to exclude by name from the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Rules to include by name in the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"baseline": {
"$ref": "#/definitions/resourceName",
"description": "The name of a baseline to use.",
"markdownDescription": "The name of a baseline to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#rulebaseline)",
"title": "Baseline",
"type": "string"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"properties": {
"obsolete": {
"default": false,
"description": "A common annotation that flags the resource as obsolete.",
"title": "Obsolete",
"type": "boolean"
}
},
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"tags": {
"$ref": "#/definitions/resourceTags"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"resourceTags": {
"additionalProperties": {
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Tag key/ value"
}
],
"description": "Additional indexed key/ value pairs for the resource.",
"title": "Tags",
"type": "object"
},
"rule-v1": {
"description": "A rule resource.",
"markdownDescription": "A rule resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A rule resource.",
"enum": [
"Rule"
],
"markdownDescription": "A rule resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ruleMetadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/ruleSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Rule",
"type": "object"
},
"ruleMetadata": {
"description": "Additional information to identify the resource.",
"properties": {
"alias": {
"description": "Alternative names this resource is known by.",
"items": {
"$ref": "#/definitions/resourceName",
"description": "An alternative name.",
"title": "Alias",
"type": "string"
},
"title": "Aliases",
"type": "array",
"uniqueItems": true
},
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"ref": {
"$ref": "#/definitions/resourceName",
"description": "An optional stable opaque identifier of this resource for lookup. This must be unique if set.",
"title": "Reference"
},
"tags": {
"$ref": "#/definitions/resourceTags"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"ruleSpec": {
"additionalProperties": false,
"description": "The specification for the rule.",
"markdownDescription": "The specification for the rule. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"properties": {
"condition": {
"$ref": "#/definitions/selectorExpression",
"description": "A condition is made up of one or more expressions that will determine if the rule passes or fails.",
"markdownDescription": "A condition is made up of one or more [expressions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/) that will determine if the rule passes or fails. [See help](https://microsoft.github.io/PSRule/v2/authoring/writing-rules/)",
"title": "Condition",
"type": "object"
},
"level": {
"default": "Error",
"description": "If the rule fails, how serious is the result. By default this is set to Error.",
"enum": [
"Error",
"Warning",
"Information"
],
"markdownDescription": "If the rule fails, how serious is the result. By default this is set to `Error`. [See help](https://microsoft.github.io/PSRule/v2/authoring/writing-rules/)",
"title": "Level",
"type": "string"
},
"type": {
"description": "This rule only applies to objects that match the specifies types.",
"items": {
"type": "string"
},
"title": "Type pre-condition",
"type": "array",
"uniqueItems": true
},
"with": {
"description": "This rule only applies to objects that match the specified selectors.",
"items": {
"type": "string"
},
"title": "Selector pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"condition"
],
"title": "Spec",
"type": "object"
},
"selector-v1": {
"description": "A selector resource.",
"markdownDescription": "A selector resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionSetOf"
},
{
"$ref": "#/definitions/selectorConditionSubset"
},
{
"$ref": "#/definitions/selectorConditionCount"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
},
{
"$ref": "#/definitions/selectorConditionHasSchema"
},
{
"$ref": "#/definitions/selectorConditionVersion"
},
{
"$ref": "#/definitions/selectorConditionHasDefault"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)",
"title": "Contains"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionCount": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"count": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#count)",
"minimum": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"equals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)",
"title": "Equals"
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasDefault": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasdefault)",
"title": "Case sensitive",
"type": "boolean"
},
"hasDefault": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "The field must either not exist or be set to the configured value.",
"markdownDescription": "The field must either not exist or be set to the configured value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasdefault)",
"title": "Has Default"
}
},
"required": [
"hasDefault"
],
"type": "object"
},
"selectorConditionHasSchema": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing schemas is case-sensitive.",
"markdownDescription": "Determines if comparing schemas is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Case sensitive",
"type": "boolean"
},
"hasSchema": {
"default": [],
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"items": {
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"minLength": 1,
"title": "Has schema",
"type": "string"
},
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Has schema",
"type": "array",
"uniqueItems": true
},
"ignoreScheme": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Ignore scheme",
"type": "boolean"
}
},
"required": [
"hasSchema"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"in": {
"description": "Must equal one of the specified values.",
"markdownDescription": "Must equal one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notEquals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)",
"title": "Not Equals"
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the specified values.",
"markdownDescription": "Must not equal any of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionSetOf": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#setof)",
"title": "Case sensitive",
"type": "boolean"
},
"setOf": {
"description": "Must include all of but only specified values.",
"markdownDescription": "Must include all of but only values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#setof)",
"title": "SetOf",
"type": "array"
}
},
"required": [
"setOf"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorConditionSubset": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Case sensitive",
"type": "boolean"
},
"subset": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Subset",
"type": "array"
},
"unique": {
"default": false,
"description": "Determines if each of the field values must be unique.",
"markdownDescription": "Determines if each of the field values must be unique. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Unique",
"type": "boolean"
}
},
"required": [
"subset"
],
"type": "object"
},
"selectorConditionVersion": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"includePrerelease": {
"default": false,
"description": "Determines if pre-release versions are included. By default, pre-release versions are not included.",
"markdownDescription": "Determines if pre-release versions are included. By default, pre-release versions are not included. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#version)",
"title": "Include pre-release",
"type": "boolean"
},
"version": {
"default": "",
"description": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range.",
"markdownDescription": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#version)",
"title": "Version",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValue": {
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "integer"
}
]
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#allof)",
"title": "All Of",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#anyof)",
"title": "Any Of",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
}
]
},
"selectorPropertiesString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
},
{
"$ref": "#/definitions/selectorPropertyType"
},
{
"$ref": "#/definitions/selectorPropertyName"
}
]
},
"selectorPropertyField": {
"properties": {
"field": {
"default": ".",
"description": "The object path of a field to compare.",
"markdownDescription": "The object path of a field to compare. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
},
"selectorPropertyName": {
"properties": {
"name": {
"default": ".",
"description": "The target name of the object.",
"markdownDescription": "The target name of the object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#name)",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
]
},
"selectorPropertyType": {
"properties": {
"type": {
"default": ".",
"description": "The target type of the object.",
"markdownDescription": "The target type of the object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#type)",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "The specification for a selector.",
"markdownDescription": "The specification for a selector. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"description": "A condition is made up of one or more expressions that will determine if an object is selected by the selector.",
"markdownDescription": "A condition is made up of one or more [expressions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/) that will determine if an object is selected by the selector. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"title": "If",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
},
"suppressionGroup-v1": {
"description": "A PSRule Suppression Group",
"markdownDescription": "A PSRule Suppression Group. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_SuppressionGroups/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule SuppressionGroup resource.",
"enum": [
"SuppressionGroup"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/suppressionGroupSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "SuppressionGroup",
"type": "object"
},
"suppressionGroupSpec": {
"additionalProperties": false,
"description": "PSRule Suppression Group specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"rule": {
"description": "This only applies to rules that match the specified rule names",
"items": {
"type": "string"
},
"title": "Rule pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/rule-v1"
},
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
},
{
"$ref": "#/definitions/suppressionGroup-v1"
}
]
} | MIT | en |
microsoft/PSRule | 5a52e4d9004e230ee83124c0e1f953c85f6b3f19 | 2022-03-20T15:03:07 | schemas/PSRule-options.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is `true`.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is `true`.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, and RunInfo.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, and `RunInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"Default"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"url": {
"description": "The URL to the repository.",
"markdownDescription": "The URL to the repository.",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule | 94f5bc29c9a86f20ef1f700cc3f7e54df272b7eb | 2022-01-31T08:37:18 | schemas/PSRule-options.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is `true`.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is `true`.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, and SupportLinks.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, and `SupportLinks`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, and RunInfo.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, and `RunInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"Default"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "number"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule | 135e1685e549e6458007678bafe2fad525df3d8f | 2023-02-23T14:07:42 | schemas/PSRule-options.schema.json | 359 | 2024-05-27T09:34:56.226398Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_AKS_CLUSTER_MINIMUM_VERSION": {
"default": "1.25.4",
"description": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified.",
"markdownDescription": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-rules/#aks-minimum-kubernetes-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "AKS cluster minimum version",
"type": "string"
},
"AZURE_BICEP_CHECK_TOOL": {
"default": false,
"description": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to true.",
"markdownDescription": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to `true`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#checking-bicep-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Checking Bicep Tool",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_BICEP_MINIMUM_VERSION": {
"default": "0.4.451",
"description": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is 0.4.451.",
"markdownDescription": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is `0.4.451`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#configuring-minimum-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep Minimum Version",
"type": "string"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown.\n\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"initialSessionState": {
"default": "BuiltIn",
"description": "Determines how the initial session state for executing PowerShell code is created. The default is BuiltIn.",
"enum": [
"BuiltIn",
"Minimal"
],
"markdownDescription": "Determines how the initial session state for executing PowerShell code is created. The default is `BuiltIn`.\n- When set to `BuiltIn` all built-in cmdlets are loaded.\n- When set to `Minimal` only cmdlets for hosting PowerShell will be loaded.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninitialsessionstate)",
"title": "Initial Session State",
"type": "string"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is true.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is true.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
},
"suppressionGroupExpired": {
"default": "Warn",
"description": "Determines how to handle expired suppression groups. Regardless of the value, an expired suppression group will be ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle expired suppression groups.\n\nRegardless of the value, an expired suppression group will be ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressiongroupexpired)",
"title": "Expired suppression groups",
"type": "string"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"ignoreUnchangedPath": {
"default": false,
"description": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed.",
"markdownDescription": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreunchangedpath)",
"title": "Ignore unchanged path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jobSummaryPath": {
"description": "The path to a job summary output file.",
"markdownDescription": "The path to a job summary output file. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjobsummarypath)",
"title": "Job Summary Path",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"baseRef": {
"description": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system.",
"markdownDescription": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositorybaseref)",
"title": "Base Reference",
"type": "string"
},
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/promptbase | cc95aa10e6ab40385847f8f68a2b91ceba0a7082 | 2024-01-19T13:33:39 | azureml/json_schemas/multiplechoice_cot_schema.json | 5,150 | 2024-05-27T06:35:12.429311Z | {
"$id": "promptbase.multiplechoice_cot",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A sample multiple choice question with a chain of thought",
"properties": {
"chain_of_thought": {
"description": "A chain of thought leading to the correct answer",
"type": "string"
},
"choices": {
"description": "A list of possible answers to the question",
"items": {
"type": "string"
},
"minItems": 2,
"type": "array",
"uniqueItems": true
},
"correct_answer": {
"description": "The index of the correct answer within the 'choices' array",
"minimum": 0,
"type": "integer"
},
"question": {
"description": "The question being asked",
"type": "string"
}
},
"required": [
"question",
"choices",
"chain_of_thought",
"correct_answer"
],
"title": "Multiple Choice Question with Chain-of-Thought",
"type": "object"
} | MIT | en |
microsoft/promptbase | 94b52b5f3e11d32a0833e72a30a5221da1561f03 | 2024-01-09T13:27:43 | azureml/json_schemas/multichoice_schema.json | 5,150 | 2024-05-27T06:35:12.429311Z | {
"$id": "promptbase.multiplechoice",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A sample multiple choice question",
"properties": {
"choices": {
"description": "A list of possible answers to the question",
"items": {
"type": "string"
},
"minItems": 2,
"type": "array",
"uniqueItems": true
},
"correct_answer": {
"description": "The index of the correct answer within the 'choices' array",
"minimum": 0,
"type": "integer"
},
"question": {
"description": "The question being asked",
"type": "string"
}
},
"required": [
"question",
"choices",
"correct_answer"
],
"title": "Multiple Choice Question",
"type": "object"
} | MIT | en |
microsoft/json-schemas | 911e6e170c894ad5b277724a6f45fd9c4920c01e | 2023-12-03T12:22:13 | dotnet/target-framework-moniker.schema.json | 63 | 2024-05-27T05:49:34.857693Z | {
"$id": "https://raw.github.com/Lordfirespeed/NuGet-GameLib-Dehumidifier/tree/main/assets/dotnet-target-framework-moniker.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": ".NET Core",
"enum": [
"netcoreapp1.0",
"netcoreapp1.1",
"netcoreapp2.0",
"netcoreapp2.1",
"netcoreapp2.2",
"netcoreapp3.0",
"netcoreapp3.1"
],
"type": "string"
},
{
"description": ".NET 5",
"pattern": "^net5\\.0(-windows((0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*)){0,2})?)?$",
"type": "string"
},
{
"description": ".NET 6",
"pattern": "^net6\\.0(-(android|ios|maccatalyst|macos|tvos|windows)((0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*)){0,2})?)?$",
"type": "string"
},
{
"description": ".NET 7",
"pattern": "^net7\\.0(-(android|ios|maccatalyst|macos|tvos|windows)((0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*)){0,2})?)?$",
"type": "string"
},
{
"description": ".NET 8",
"pattern": "^net8\\.0(-(android|browser|ios|maccatalyst|macos|tvos|windows)((0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*)){0,2})?)?$",
"type": "string"
},
{
"description": ".NET Standard",
"enum": [
"netstandard1.0",
"netstandard1.1",
"netstandard1.2",
"netstandard1.3",
"netstandard1.4",
"netstandard1.5",
"netstandard1.6",
"netstandard2.0",
"netstandard2.1"
],
"type": "string"
},
{
"description": ".NET Framework",
"enum": [
"net11",
"net20",
"net35",
"net40",
"net403",
"net45",
"net451",
"net452",
"net46",
"net461",
"net462",
"net47",
"net471",
"net472",
"net48"
],
"type": "string"
},
{
"description": "Windows Store",
"enum": [
"netcore",
"netcore45",
"netcore451"
],
"type": "string"
},
{
"description": ".NET Micro Framework",
"enum": [
"netmf"
],
"type": "string"
},
{
"description": "Silverlight",
"enum": [
"sl4",
"sl5"
],
"type": "string"
},
{
"description": "Windows Phone",
"enum": [
"wp",
"wp7",
"wp75",
"wp8",
"wp81",
"wpa81"
],
"type": "string"
},
{
"description": "Universal Windows Platform",
"enum": [
"uap",
"uap10.0"
],
"type": "string"
},
{
"description": "Deprecated",
"enum": [
"aspnet50",
"aspnetcore50",
"dnxcore50",
"dnx",
"dnx45",
"dnx451",
"dnx452",
"dotnet",
"dotnet50",
"dotnet51",
"dotnet52",
"dotnet53",
"dotnet54",
"dotnet55",
"dotnet56",
"netcore50",
"win",
"win8",
"win81",
"win10",
"wirt"
],
"type": "string"
}
],
"description": "Used to specify a particular .NET framework version as a build target.",
"title": ".NET Target Framework Moniker",
"type": "string"
} | MIT | en |
microsoft/json-schemas | 6bb67b3344890e117d88d1a6e058b495833ba6b7 | 2023-12-03T12:24:25 | dotnet/target-framework-moniker.schema.json | 63 | 2024-05-27T05:49:34.857693Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": ".NET Core",
"enum": [
"netcoreapp1.0",
"netcoreapp1.1",
"netcoreapp2.0",
"netcoreapp2.1",
"netcoreapp2.2",
"netcoreapp3.0",
"netcoreapp3.1"
],
"type": "string"
},
{
"description": ".NET 5",
"pattern": "^net5\\.0(-windows((0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*)){0,2})?)?$",
"type": "string"
},
{
"description": ".NET 6",
"pattern": "^net6\\.0(-(android|ios|maccatalyst|macos|tvos|windows)((0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*)){0,2})?)?$",
"type": "string"
},
{
"description": ".NET 7",
"pattern": "^net7\\.0(-(android|ios|maccatalyst|macos|tvos|windows)((0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*)){0,2})?)?$",
"type": "string"
},
{
"description": ".NET 8",
"pattern": "^net8\\.0(-(android|browser|ios|maccatalyst|macos|tvos|windows)((0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*)){0,2})?)?$",
"type": "string"
},
{
"description": ".NET Standard",
"enum": [
"netstandard1.0",
"netstandard1.1",
"netstandard1.2",
"netstandard1.3",
"netstandard1.4",
"netstandard1.5",
"netstandard1.6",
"netstandard2.0",
"netstandard2.1"
],
"type": "string"
},
{
"description": ".NET Framework",
"enum": [
"net11",
"net20",
"net35",
"net40",
"net403",
"net45",
"net451",
"net452",
"net46",
"net461",
"net462",
"net47",
"net471",
"net472",
"net48"
],
"type": "string"
},
{
"description": "Windows Store",
"enum": [
"netcore",
"netcore45",
"netcore451"
],
"type": "string"
},
{
"description": ".NET Micro Framework",
"enum": [
"netmf"
],
"type": "string"
},
{
"description": "Silverlight",
"enum": [
"sl4",
"sl5"
],
"type": "string"
},
{
"description": "Windows Phone",
"enum": [
"wp",
"wp7",
"wp75",
"wp8",
"wp81",
"wpa81"
],
"type": "string"
},
{
"description": "Universal Windows Platform",
"enum": [
"uap",
"uap10.0"
],
"type": "string"
},
{
"description": "Deprecated",
"enum": [
"aspnet50",
"aspnetcore50",
"dnxcore50",
"dnx",
"dnx45",
"dnx451",
"dnx452",
"dotnet",
"dotnet50",
"dotnet51",
"dotnet52",
"dotnet53",
"dotnet54",
"dotnet55",
"dotnet56",
"netcore50",
"win",
"win8",
"win81",
"win10",
"wirt"
],
"type": "string"
}
],
"description": "Used to specify a particular .NET framework version as a build target.",
"title": ".NET Target Framework Moniker",
"type": "string"
} | MIT | en |
microsoft/PSRule-vscode | faa10966f4464896f9e40e7730b88ae611df918d | 2020-04-02T07:20:56 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"title": "Name separator",
"type": "string"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"description": "A set of key/ value configuration options for rules.",
"title": "Configuration values",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"title": "Warn on unprocessed objects",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"Detect"
],
"title": "Input format",
"type": "string"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"title": "Object path",
"type": "string"
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"execution": {
"oneOf": [
{
"$ref": "#/definitions/execution-option"
}
],
"type": "object"
},
"input": {
"oneOf": [
{
"$ref": "#/definitions/input-option"
}
],
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"title": "Result type",
"type": "string"
},
"culture": {
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"title": "Encoding",
"type": "string"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"NUnit3",
"Csv",
"Wide"
],
"title": "Output format",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Client",
"description": "The style that results will be presented in.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions"
],
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Specifies rules to exclude by name.",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Optionally filter to rules by name.",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"title": "Suppress when",
"type": "string"
},
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"oneOf": [
{
"$ref": "#/definitions/options"
}
],
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 33ba3c920662b89202b77c513d9c48233ee7f0d2 | 2021-07-19T00:14:38 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"oneOf": [
{
"$ref": "#/definitions/execution-option"
}
],
"type": "object"
},
"input": {
"oneOf": [
{
"$ref": "#/definitions/input-option"
}
],
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, and SupportLinks.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, and `SupportLinks`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputencoding)",
"title": "Encoding",
"type": "string"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputformat)",
"title": "Output format",
"type": "string"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputpath)",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"title": "Required modules",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Specifies rules to exclude by name.",
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Optionally filter to rules by name.",
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | e07b92cda71b25a3197852f16d523713569054d5 | 2022-03-08T05:48:48 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is `true`.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is `true`.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, and RunInfo.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, and `RunInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"Default"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"url": {
"description": "The URL to the repository.",
"markdownDescription": "The URL to the repository.",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 12ff821c2d539aef0a060bc58bd2b6ecacc9836f | 2020-10-20T09:24:49 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputformat)",
"title": "Input format",
"type": "string"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"execution": {
"oneOf": [
{
"$ref": "#/definitions/execution-option"
}
],
"type": "object"
},
"input": {
"oneOf": [
{
"$ref": "#/definitions/input-option"
}
],
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputas)",
"title": "Result type",
"type": "string"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputencoding)",
"title": "Encoding",
"type": "string"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputformat)",
"title": "Output format",
"type": "string"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputpath)",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Client",
"description": "The style that results will be presented in. The default is Client.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions"
],
"markdownDescription": "The style that results will be presented in. The default is `Client`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"type": "string"
},
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"title": "Required modules",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Specifies rules to exclude by name.",
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Optionally filter to rules by name.",
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 9be7614d4852fdb652a6314027f42175fd90f51e | 2021-10-22T02:14:39 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"oneOf": [
{
"$ref": "#/definitions/execution-option"
}
],
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"oneOf": [
{
"$ref": "#/definitions/input-option"
}
],
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, and SupportLinks.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, and `SupportLinks`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, and RunInfo.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, and `RunInfo`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"Default"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "number"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputpath)",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"title": "Required modules",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Specifies rules to exclude by name.",
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Optionally filter to rules by name.",
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | a1366d994717ad0bc8c2fc9230114a88e297ee61 | 2021-04-01T15:38:39 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"title": "Annotations",
"type": "object"
},
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"selector-v1": {
"description": "A PSRule Selector.",
"markdownDescription": "A PSRule Selector. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
}
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"equals": {
"oneOf": [
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "string"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "integer"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "boolean"
}
]
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"in": {
"description": "Must equal one the values.",
"markdownDescription": "Must equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"notEquals": {
"oneOf": [
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "string"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "integer"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "boolean"
}
]
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the values.",
"markdownDescription": "Must not equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#allof)",
"title": "AllOf",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#anyof)",
"title": "AnyOf",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"properties": {
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
}
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "PSRule selector specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
}
]
} | MIT | en |
microsoft/PSRule-vscode | 2ab2a5ecebf334b1db4ab216cf151e0f8b305d18 | 2024-02-03T13:06:45 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-option": {
"additionalProperties": false,
"description": "Options that configure baselines.",
"properties": {
"group": {
"additionalProperties": {
"description": "Maps a group name to a baseline.",
"title": "Group mapping",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Group}": "${2:Baseline}"
},
"label": "Baseline group"
}
],
"description": "Configure baseline group names.",
"title": "Baseline group",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_AKS_CLUSTER_MINIMUM_VERSION": {
"default": "1.27.7",
"description": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified.",
"markdownDescription": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-rules/#aks-minimum-kubernetes-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "AKS cluster minimum version",
"type": "string"
},
"AZURE_BICEP_CHECK_TOOL": {
"default": false,
"description": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to true.",
"markdownDescription": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to `true`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#checking-bicep-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Checking Bicep Tool",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_BICEP_MINIMUM_VERSION": {
"default": "0.4.451",
"description": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is 0.4.451.",
"markdownDescription": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is `0.4.451`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#configuring-minimum-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep Minimum Version",
"type": "string"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReference": {
"default": "Warn",
"description": "Determines how to handle when an alias to a resource is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle when an alias to a resource is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreference)",
"title": "Alias references",
"type": "string"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By default, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By default, an error is thrown.\n\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"hashAlgorithm": {
"default": "SHA512",
"description": "Configures the hashing algorithm used by the PSRule runtime. The default is SHA512.",
"enum": [
"SHA512",
"SHA384",
"SHA256"
],
"markdownDescription": "Configures the hashing algorithm used by the PSRule runtime. The default is `SHA512`.\n- When set to `SHA512` the SHA-512 algorithm is used for hashing functions.\n- When set to `SHA384` the SHA-384 algorithm is used for hashing functions.\n- When set to `SHA256` the SHA-256 algorithm is used for hashing functions.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionhashalgorithm)",
"title": "Hash Algorithm",
"type": "string"
},
"initialSessionState": {
"default": "BuiltIn",
"description": "Determines how the initial session state for executing PowerShell code is created. The default is BuiltIn.",
"enum": [
"BuiltIn",
"Minimal"
],
"markdownDescription": "Determines how the initial session state for executing PowerShell code is created. The default is `BuiltIn`.\n- When set to `BuiltIn` all built-in cmdlets are loaded.\n- When set to `Minimal` only cmdlets for hosting PowerShell will be loaded.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninitialsessionstate)",
"title": "Initial Session State",
"type": "string"
},
"invariantCulture": {
"default": "Warn",
"description": "Determines how to report when an invariant culture is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report when an invariant culture is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculture)",
"title": "Invariant culture",
"type": "string"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`.\n- `FullLanguage` - Executes with all language features.\n- `ConstrainedLanguage` - Executes in constrained language mode that restricts the types and methods that can be used.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language Mode",
"type": "string"
},
"restrictScriptSource": {
"default": "Unrestricted",
"description": "Configures where to allow PowerShell language features (such as rules and conventions) to run from. The default is Unrestricted.",
"enum": [
"Unrestricted",
"ModuleOnly",
"DisablePowerShell"
],
"markdownDescription": "Configures where to allow PowerShell language features (such as rules and conventions) to run from. The default is `Unrestricted`.\n- When set to `Unrestricted` PowerShell language features are allowed from workspace and modules.\n- When set to `ModuleOnly` PowerShell language features are allowed from loaded modules, but script files within the workspace are ignored.\n- When set to `DisablePowerShell` no PowerShell language features are used during PSRule run.\n\n[See help](https://microsoft.github.io/PSRule/v3/concepts/PSRule/en-US/about_PSRule_Options/#executionrestrictscriptsource)",
"title": "Restrict Script Source",
"type": "string"
},
"ruleExcluded": {
"default": "Ignore",
"description": "Determines how to handle excluded rules. Regardless of the value, excluded rules are ignored. By default, rules are excluded silently. When set to Error, an error is thrown. When set to Warn, a warning is generated. When set to Debug, a message is written to the debug log.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle excluded rules.\n\nRegardless of the value, excluded rules are ignored. By default, rules are excluded silently.\n\n- When set to `Error`, an error is thrown.\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleexcluded)",
"title": "Rule excluded",
"type": "string"
},
"ruleInconclusive": {
"default": "Warn",
"description": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleinconclusive)",
"title": "Inconclusive rules",
"type": "string"
},
"ruleSuppressed": {
"default": "Warn",
"description": "Determines how to handle suppressed rules. Regardless of the value, a suppressed rule is ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle suppressed rules.\n\nRegardless of the value, a suppressed rule is ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionrulesuppressed)",
"title": "Rule suppressed",
"type": "string"
},
"suppressionGroupExpired": {
"default": "Warn",
"description": "Determines how to handle expired suppression groups. Regardless of the value, an expired suppression group will be ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle expired suppression groups.\n\nRegardless of the value, an expired suppression group will be ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressiongroupexpired)",
"title": "Expired suppression groups",
"type": "string"
},
"unprocessedObject": {
"default": "Warn",
"description": "Determines how to report objects that are not processed by any rule. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report objects that are not processed by any rule. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionunprocessedobject)",
"title": "Unprocessed object",
"type": "string"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"ignoreUnchangedPath": {
"default": false,
"description": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed.",
"markdownDescription": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreunchangedpath)",
"title": "Ignore unchanged path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"baseline": {
"$ref": "#/definitions/baseline-option",
"type": "object"
},
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jobSummaryPath": {
"description": "The path to a job summary output file.",
"markdownDescription": "The path to a job summary output file. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjobsummarypath)",
"title": "Job Summary Path",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"baseRef": {
"description": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository base ref used for comparisons of changed files.\n\nBy default, the base ref is detected from environment variables set by the build system.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositorybaseref)",
"title": "Base Reference",
"type": "string"
},
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output.\n\nBy default, the repository URL is detected from environment variables set by the build system.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "PSRule options configuration file.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 7bb4e8aed9b1ee593199cc83515934f3d86b9022 | 2021-08-08T15:09:40 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"oneOf": [
{
"$ref": "#/definitions/execution-option"
}
],
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"oneOf": [
{
"$ref": "#/definitions/input-option"
}
],
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, and SupportLinks.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, and `SupportLinks`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputencoding)",
"title": "Encoding",
"type": "string"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputformat)",
"title": "Output format",
"type": "string"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputpath)",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"title": "Required modules",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Specifies rules to exclude by name.",
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Optionally filter to rules by name.",
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 05ba61783516471ab18ce67a83f0a05e77a10144 | 2021-11-09T11:06:43 | schemas/PSRule-resources.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A schema for PSRule resources.",
"items": {
"anyOf": [
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/rule-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/baseline-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/moduleConfig-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/selector-v1"
}
]
},
"title": "PSRule resources",
"type": "array"
} | MIT | en |
microsoft/PSRule-vscode | ef84c902318b7c02ec765b7435069d5583a32aa2 | 2022-01-31T22:13:20 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"baseline": {
"$ref": "#/definitions/rule-names",
"description": "The name of a baseline to use.",
"markdownDescription": "The name of a baseline to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#rulebaseline)",
"title": "Baseline",
"type": "string"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"title": "Annotations",
"type": "object"
},
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"title": "Tags",
"type": "object"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-v1": {
"description": "A PSRule Rule.",
"markdownDescription": "A PSRule Rule. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Rules.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Rule resource.",
"enum": [
"Rule"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/ruleSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Rule",
"type": "object"
},
"ruleSpec": {
"additionalProperties": false,
"description": "PSRule rule specification.",
"properties": {
"condition": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"type": {
"description": "This rule only applies to objects that match the specifies types.",
"items": {
"type": "string"
},
"title": "Type pre-condition",
"type": "array",
"uniqueItems": true
},
"with": {
"description": "This rule only applies to objects that match the specified selectors.",
"items": {
"type": "string"
},
"title": "Selector pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"condition"
],
"title": "Spec",
"type": "object"
},
"selector-v1": {
"description": "A PSRule Selector.",
"markdownDescription": "A PSRule Selector. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionSetOf"
},
{
"$ref": "#/definitions/selectorConditionSubset"
},
{
"$ref": "#/definitions/selectorConditionCount"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
},
{
"$ref": "#/definitions/selectorConditionHasSchema"
},
{
"$ref": "#/definitions/selectorConditionVersion"
},
{
"$ref": "#/definitions/selectorConditionHasDefault"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#contains)",
"title": "Contains"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionCount": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"count": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#count)",
"minimum": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"equals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals"
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasDefault": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasdefault)",
"title": "Case sensitive",
"type": "boolean"
},
"hasDefault": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "The field must either not exist or be set to the configured value.",
"markdownDescription": "The field must either not exist or be set to the configured value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasdefault)",
"title": "Has Default"
}
},
"required": [
"hasDefault"
],
"type": "object"
},
"selectorConditionHasSchema": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing schemas is case-sensitive.",
"markdownDescription": "Determines if comparing schemas is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"title": "Case sensitive",
"type": "boolean"
},
"hasSchema": {
"default": [],
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"items": {
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"minLength": 1,
"title": "Has schema",
"type": "string"
},
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"title": "Has schema",
"type": "array",
"uniqueItems": true
},
"ignoreScheme": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"title": "Ignore scheme",
"type": "boolean"
}
},
"required": [
"hasSchema"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"in": {
"description": "Must equal one the values.",
"markdownDescription": "Must equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notEquals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals"
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the values.",
"markdownDescription": "Must not equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionSetOf": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#setof)",
"title": "Case sensitive",
"type": "boolean"
},
"setOf": {
"description": "Must include all of but only specified values.",
"markdownDescription": "Must include all of but only values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#setof)",
"title": "SetOf",
"type": "array"
}
},
"required": [
"setOf"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorConditionSubset": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Case sensitive",
"type": "boolean"
},
"subset": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Subset",
"type": "array"
},
"unique": {
"default": false,
"description": "Determines if each of the field values must be unique.",
"markdownDescription": "Determines if each of the field values must be unique. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Unique",
"type": "boolean"
}
},
"required": [
"subset"
],
"type": "object"
},
"selectorConditionVersion": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"includePrerelease": {
"default": false,
"description": "Determines if pre-release versions are included. By default, pre-release versions are not included.",
"markdownDescription": "Determines if pre-release versions are included. By default, pre-release versions are not included. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#version)",
"title": "Include pre-release",
"type": "boolean"
},
"version": {
"default": "",
"description": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range.",
"markdownDescription": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#version)",
"title": "Version",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValue": {
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "integer"
}
]
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#allof)",
"title": "All Of",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#anyof)",
"title": "Any Of",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
}
]
},
"selectorPropertiesString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
},
{
"$ref": "#/definitions/selectorPropertyType"
},
{
"$ref": "#/definitions/selectorPropertyName"
}
]
},
"selectorPropertyField": {
"properties": {
"field": {
"default": ".",
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
},
"selectorPropertyName": {
"properties": {
"name": {
"default": ".",
"description": "The target name of the object.",
"markdownDescription": "The target name of the object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#name)",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
]
},
"selectorPropertyType": {
"properties": {
"type": {
"default": ".",
"description": "The target type of the object.",
"markdownDescription": "The target type of the object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#type)",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "PSRule selector specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
},
"suppressionGroup-v1": {
"description": "A PSRule Suppression Group",
"markdownDescription": "A PSRule Suppression Group. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_SuppressionGroups/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule SuppressionGroup resource.",
"enum": [
"SuppressionGroup"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/suppressionGroupSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "SuppressionGroup",
"type": "object"
},
"suppressionGroupSpec": {
"additionalProperties": false,
"description": "PSRule Suppression Group specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"rule": {
"description": "This only applies to rules that match the specified rule names",
"items": {
"type": "string"
},
"title": "Rule pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/rule-v1"
},
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
},
{
"$ref": "#/definitions/suppressionGroup-v1"
}
]
} | MIT | en |
microsoft/PSRule-vscode | 657528aac7b6174bb56415e1e0b3fc3c3092f388 | 2021-03-18T13:57:13 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Baseline",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
}
},
"title": "ModuleConfig",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"title": "Annotations",
"type": "object"
},
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML language files.",
"oneOf": [
{
"$ref": "#/definitions/baseline"
},
{
"$ref": "#/definitions/moduleConfig"
}
],
"title": "PSRule language"
} | MIT | en |
microsoft/PSRule-vscode | a1366d994717ad0bc8c2fc9230114a88e297ee61 | 2021-04-01T15:38:39 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputformat)",
"title": "Input format",
"type": "string"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"oneOf": [
{
"$ref": "#/definitions/execution-option"
}
],
"type": "object"
},
"input": {
"oneOf": [
{
"$ref": "#/definitions/input-option"
}
],
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputas)",
"title": "Result type",
"type": "string"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputencoding)",
"title": "Encoding",
"type": "string"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputformat)",
"title": "Output format",
"type": "string"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputpath)",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Client",
"description": "The style that results will be presented in. The default is Client.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions"
],
"markdownDescription": "The style that results will be presented in. The default is `Client`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"type": "string"
},
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"title": "Required modules",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Specifies rules to exclude by name.",
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Optionally filter to rules by name.",
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | bfc86b6c34dff03280a23c3a33a31bc300ccb290 | 2022-03-21T22:42:40 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is `true`.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is `true`.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, and RunInfo.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, and `RunInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"Default"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"url": {
"description": "The URL to the repository.",
"markdownDescription": "The URL to the repository.",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 7dbfc05fa3466c1ff0656cdb9cdf3f89d72be222 | 2021-06-01T12:14:43 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"oneOf": [
{
"$ref": "#/definitions/execution-option"
}
],
"type": "object"
},
"input": {
"oneOf": [
{
"$ref": "#/definitions/input-option"
}
],
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, and SupportLinks.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, and `SupportLinks`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputencoding)",
"title": "Encoding",
"type": "string"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputformat)",
"title": "Output format",
"type": "string"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputpath)",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"pattern": "^(@pre|@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"title": "Required modules",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Specifies rules to exclude by name.",
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Optionally filter to rules by name.",
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 54995eb1c6ed614a2947a3e094d85defb150bd23 | 2021-05-06T05:08:49 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"oneOf": [
{
"$ref": "#/definitions/execution-option"
}
],
"type": "object"
},
"input": {
"oneOf": [
{
"$ref": "#/definitions/input-option"
}
],
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputas)",
"title": "Result type",
"type": "string"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputencoding)",
"title": "Encoding",
"type": "string"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputformat)",
"title": "Output format",
"type": "string"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputpath)",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Client",
"description": "The style that results will be presented in. The default is Client.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions"
],
"markdownDescription": "The style that results will be presented in. The default is `Client`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"type": "string"
},
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"title": "Required modules",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Specifies rules to exclude by name.",
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Optionally filter to rules by name.",
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | e2d8b150e2dae54b448212e97ca9ed2e4e86ce6e | 2024-01-17T14:28:32 | schemas/PSRule-lock.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "A schema for the PSRule lock file.",
"properties": {
"modules": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"version": {
"description": "The version of the module to use.",
"title": "Module version",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"description": "A list of specific module versions for PSRule to restore.",
"title": "Modules",
"type": "object"
},
"version": {
"description": "The version of the lock file schema.",
"enum": [
1
],
"title": "Version",
"type": "integer"
}
},
"required": [
"version",
"modules"
],
"title": "PSRule lock",
"type": "object"
} | MIT | en |
microsoft/PSRule-vscode | 722bc60793b11ef494a83bb64cf29d3a433c1b22 | 2023-06-08T17:19:05 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-option": {
"additionalProperties": false,
"description": "Options that configure baselines.",
"properties": {
"group": {
"additionalProperties": {
"description": "Maps a group name to a baseline.",
"title": "Group mapping",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Group}": "${2:Baseline}"
},
"label": "Baseline group"
}
],
"description": "Configure baseline group names.",
"title": "Baseline group",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_AKS_CLUSTER_MINIMUM_VERSION": {
"default": "1.25.4",
"description": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified.",
"markdownDescription": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-rules/#aks-minimum-kubernetes-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "AKS cluster minimum version",
"type": "string"
},
"AZURE_BICEP_CHECK_TOOL": {
"default": false,
"description": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to true.",
"markdownDescription": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to `true`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#checking-bicep-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Checking Bicep Tool",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_BICEP_MINIMUM_VERSION": {
"default": "0.4.451",
"description": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is 0.4.451.",
"markdownDescription": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is `0.4.451`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#configuring-minimum-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep Minimum Version",
"type": "string"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReference": {
"default": "Warn",
"description": "Determines how to handle when an alias to a resource is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces aliasReferenceWarning. You do not need to configure both options. If aliasReferenceWarning is configured, it will override aliasReference with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle when an alias to a resource is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `aliasReferenceWarning`. You do not need to configure both options. If `aliasReferenceWarning` is configured, it will override `aliasReference` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreference)",
"title": "Alias references",
"type": "string"
},
"aliasReferenceWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases | DEPRECATED",
"type": "boolean"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown.\n\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"inconclusiveWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules | DEPRECATED",
"type": "boolean"
},
"initialSessionState": {
"default": "BuiltIn",
"description": "Determines how the initial session state for executing PowerShell code is created. The default is BuiltIn.",
"enum": [
"BuiltIn",
"Minimal"
],
"markdownDescription": "Determines how the initial session state for executing PowerShell code is created. The default is `BuiltIn`.\n- When set to `BuiltIn` all built-in cmdlets are loaded.\n- When set to `Minimal` only cmdlets for hosting PowerShell will be loaded.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninitialsessionstate)",
"title": "Initial Session State",
"type": "string"
},
"invariantCulture": {
"default": "Warn",
"description": "Determines how to report when an invariant culture is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces invariantCultureWarning. You do not need to configure both options. If invariantCultureWarning is configured, it will override invariantCulture with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report when an invariant culture is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `invariantCultureWarning`. You do not need to configure both options. If `invariantCultureWarning` is configured, it will override `invariantCulture` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculture)",
"title": "Invariant culture",
"type": "string"
},
"invariantCultureWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warning when invariant culture is used. The default is true.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture | DEPRECATED",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects | DEPRECATED",
"type": "boolean"
},
"ruleExcluded": {
"default": "Ignore",
"description": "Determines how to handle excluded rules. Regardless of the value, excluded rules are ignored. By default, rules are excluded silently. When set to Error, an error is thrown. When set to Warn, a warning is generated. When set to Debug, a message is written to the debug log.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle excluded rules.\n\nRegardless of the value, excluded rules are ignored. By default, rules are excluded silently.\n\n- When set to `Error`, an error is thrown.\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleexcluded)",
"title": "Rule excluded",
"type": "string"
},
"ruleInconclusive": {
"default": "Warn",
"description": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces inconclusiveWarning. You do not need to configure both options. If inconclusiveWarning is configured, it will override ruleInconclusive with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `inconclusiveWarning`. You do not need to configure both options. If `inconclusiveWarning` is configured, it will override `ruleInconclusive` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleinconclusive)",
"title": "Inconclusive rules",
"type": "string"
},
"ruleSuppressed": {
"default": "Warn",
"description": "Determines how to handle suppressed rules. Regardless of the value, a suppressed rule is ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces suppressedRuleWarning. You do not need to configure both options. If suppressedRuleWarning is configured, it will override ruleSuppressed with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle suppressed rules.\n\nRegardless of the value, a suppressed rule is ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `suppressedRuleWarning`. You do not need to configure both options. If `suppressedRuleWarning` is configured, it will override `ruleSuppressed` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionrulesuppressed)",
"title": "Rule suppressed",
"type": "string"
},
"suppressedRuleWarning": {
"default": true,
"deprecated": true,
"description": "This option has been deprecated and will be removed from v3 in favor of ruleSuppressed. Enable or disable warnings for suppressed rules. The default is true.",
"markdownDescription": "This option has been deprecated and will be removed from v3 in favor of `ruleSuppressed`.\n\nEnable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules | DEPRECATED",
"type": "boolean"
},
"suppressionGroupExpired": {
"default": "Warn",
"description": "Determines how to handle expired suppression groups. Regardless of the value, an expired suppression group will be ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle expired suppression groups.\n\nRegardless of the value, an expired suppression group will be ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressiongroupexpired)",
"title": "Expired suppression groups",
"type": "string"
},
"unprocessedObject": {
"default": "Warn",
"description": "Determines how to report objects that are not processed by any rule. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces notProcessedWarning. You do not need to configure both options. If notProcessedWarning is configured, it will override unprocessedObject with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report objects that are not processed by any rule. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `notProcessedWarning`. You do not need to configure both options. If `notProcessedWarning` is configured, it will override `unprocessedObject` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionunprocessedobject)",
"title": "Unprocessed object",
"type": "string"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"ignoreUnchangedPath": {
"default": false,
"description": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed.",
"markdownDescription": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreunchangedpath)",
"title": "Ignore unchanged path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"baseline": {
"$ref": "#/definitions/baseline-option",
"type": "object"
},
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jobSummaryPath": {
"description": "The path to a job summary output file.",
"markdownDescription": "The path to a job summary output file. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjobsummarypath)",
"title": "Job Summary Path",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"baseRef": {
"description": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system.",
"markdownDescription": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositorybaseref)",
"title": "Base Reference",
"type": "string"
},
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "PSRule options configuration file.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 820815c76be2b0a9599b8ed8236abc4e89095add | 2020-07-22T12:53:12 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"title": "Name separator",
"type": "string"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"description": "A set of key/ value configuration options for rules.",
"title": "Configuration values",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"title": "Warn on unprocessed objects",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"Detect"
],
"title": "Input format",
"type": "string"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"title": "Object path",
"type": "string"
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"execution": {
"oneOf": [
{
"$ref": "#/definitions/execution-option"
}
],
"type": "object"
},
"input": {
"oneOf": [
{
"$ref": "#/definitions/input-option"
}
],
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"title": "Result type",
"type": "string"
},
"culture": {
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"title": "Encoding",
"type": "string"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"NUnit3",
"Csv",
"Wide"
],
"title": "Output format",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Client",
"description": "The style that results will be presented in.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions"
],
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"type": "string"
},
"description": "Specifies the required version of a module to use.",
"title": "Required modules",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Specifies rules to exclude by name.",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Optionally filter to rules by name.",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"title": "Suppress when",
"type": "string"
},
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 9b9c4ee90e7b4a22a8edde339d189037373e947a | 2022-03-07T13:21:22 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"description": "Rules to exclude by name from the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Rules to include by name in the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"baseline": {
"$ref": "#/definitions/resourceName",
"description": "The name of a baseline to use.",
"markdownDescription": "The name of a baseline to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#rulebaseline)",
"title": "Baseline",
"type": "string"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"properties": {
"obsolete": {
"default": false,
"description": "A common annotation that flags the resource as obsolete.",
"title": "Obsolete",
"type": "boolean"
}
},
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"tags": {
"$ref": "#/definitions/resourceTags"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"resourceTags": {
"additionalProperties": {
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Tag key/ value"
}
],
"description": "Additional indexed key/ value pairs for the resource.",
"title": "Tags",
"type": "object"
},
"rule-v1": {
"description": "A rule resource.",
"markdownDescription": "A rule resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A rule resource.",
"enum": [
"Rule"
],
"markdownDescription": "A rule resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ruleMetadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/ruleSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Rule",
"type": "object"
},
"ruleMetadata": {
"description": "Additional information to identify the resource.",
"properties": {
"alias": {
"description": "Alternative names this resource is known by.",
"items": {
"$ref": "#/definitions/resourceName",
"description": "An alternative name.",
"title": "Alias",
"type": "string"
},
"title": "Aliases",
"type": "array",
"uniqueItems": true
},
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"ref": {
"$ref": "#/definitions/resourceName",
"description": "An optional stable opaque identifier of this resource for lookup. This must be unique if set.",
"title": "Reference"
},
"tags": {
"$ref": "#/definitions/resourceTags"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"ruleSpec": {
"additionalProperties": false,
"description": "The specification for the rule.",
"markdownDescription": "The specification for the rule. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"properties": {
"condition": {
"$ref": "#/definitions/selectorExpression",
"description": "A condition is made up of one or more expressions that will determine if the rule passes or fails.",
"markdownDescription": "A condition is made up of one or more [expressions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/) that will determine if the rule passes or fails. [See help](https://microsoft.github.io/PSRule/v2/authoring/writing-rules/)",
"title": "Condition",
"type": "object"
},
"level": {
"default": "Error",
"description": "If the rule fails, how serious is the result. By default this is set to Error.",
"enum": [
"Error",
"Warning",
"Information"
],
"markdownDescription": "If the rule fails, how serious is the result. By default this is set to `Error`. [See help](https://microsoft.github.io/PSRule/v2/authoring/writing-rules/)",
"title": "Level",
"type": "string"
},
"type": {
"description": "This rule only applies to objects that match the specifies types.",
"items": {
"type": "string"
},
"title": "Type pre-condition",
"type": "array",
"uniqueItems": true
},
"with": {
"description": "This rule only applies to objects that match the specified selectors.",
"items": {
"type": "string"
},
"title": "Selector pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"condition"
],
"title": "Spec",
"type": "object"
},
"selector-v1": {
"description": "A selector resource.",
"markdownDescription": "A selector resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionSetOf"
},
{
"$ref": "#/definitions/selectorConditionSubset"
},
{
"$ref": "#/definitions/selectorConditionCount"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsArray"
},
{
"$ref": "#/definitions/selectorConditionIsBoolean"
},
{
"$ref": "#/definitions/selectorConditionIsDateTime"
},
{
"$ref": "#/definitions/selectorConditionIsInteger"
},
{
"$ref": "#/definitions/selectorConditionIsNumeric"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
},
{
"$ref": "#/definitions/selectorConditionHasSchema"
},
{
"$ref": "#/definitions/selectorConditionVersion"
},
{
"$ref": "#/definitions/selectorConditionHasDefault"
},
{
"$ref": "#/definitions/selectorConditionWithinPath"
},
{
"$ref": "#/definitions/selectorConditionNotWithinPath"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)",
"title": "Case sensitive",
"type": "boolean"
},
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)",
"title": "Contains"
},
"convert": {
"default": false,
"description": "Convert type to string.",
"markdownDescription": "Convert type to string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)",
"title": "Type conversion",
"type": "boolean"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionCount": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"count": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#count)",
"minimum": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type to string.",
"markdownDescription": "Convert type to string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)",
"title": "Type conversion",
"type": "boolean"
},
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive. Only applies to string values.",
"markdownDescription": "Determines if comparing values is case-sensitive. Only applies to string values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type of compared operand.",
"markdownDescription": "Convert type of compared operand. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)",
"title": "Type conversion",
"type": "boolean"
},
"equals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)",
"title": "Equals"
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasDefault": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasdefault)",
"title": "Case sensitive",
"type": "boolean"
},
"hasDefault": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "The field must either not exist or be set to the configured value.",
"markdownDescription": "The field must either not exist or be set to the configured value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasdefault)",
"title": "Has Default"
}
},
"required": [
"hasDefault"
],
"type": "object"
},
"selectorConditionHasSchema": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing schemas is case-sensitive.",
"markdownDescription": "Determines if comparing schemas is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Case sensitive",
"type": "boolean"
},
"hasSchema": {
"default": [],
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"items": {
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"minLength": 1,
"title": "Has schema",
"type": "string"
},
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Has schema",
"type": "array",
"uniqueItems": true
},
"ignoreScheme": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Ignore scheme",
"type": "boolean"
}
},
"required": [
"hasSchema"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"in": {
"description": "Must equal one of the specified values.",
"markdownDescription": "Must equal one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsArray": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isArray": {
"description": "Must be an array type.",
"markdownDescription": "Must be an array type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isarray)",
"title": "Is array",
"type": "boolean"
}
},
"required": [
"isArray"
],
"type": "object"
},
"selectorConditionIsBoolean": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to boolean.",
"markdownDescription": "Convert type to boolean. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isboolean)",
"title": "Type conversion",
"type": "boolean"
},
"isBoolean": {
"description": "Must be a boolean type.",
"markdownDescription": "Must be a boolean type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isboolean)",
"title": "Is boolean",
"type": "boolean"
}
},
"required": [
"isBoolean"
],
"type": "object"
},
"selectorConditionIsDateTime": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to datetime.",
"markdownDescription": "Convert type to datetime. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isdatetime)",
"title": "Type conversion",
"type": "boolean"
},
"isDateTime": {
"description": "Must be a datetime type.",
"markdownDescription": "Must be a datetime type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isdatetime)",
"title": "Is datetime",
"type": "boolean"
}
},
"required": [
"isDateTime"
],
"type": "object"
},
"selectorConditionIsInteger": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to integer.",
"markdownDescription": "Convert type to integer. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isinteger)",
"title": "Type conversion",
"type": "boolean"
},
"isInteger": {
"description": "Must be an integer type.",
"markdownDescription": "Must be an integer type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isinteger)",
"title": "Is integer",
"type": "boolean"
}
},
"required": [
"isInteger"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsNumeric": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to numeric.",
"markdownDescription": "Convert type to numeric. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isnumeric)",
"title": "Type conversion",
"type": "boolean"
},
"isNumeric": {
"description": "Must be a numeric type.",
"markdownDescription": "Must be a numeric type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isnumeric)",
"title": "Is numeric",
"type": "boolean"
}
},
"required": [
"isNumeric"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive. Only applies to string values.",
"markdownDescription": "Determines if comparing values is case-sensitive. Only applies to string values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type of compared operand.",
"markdownDescription": "Convert type of compared operand. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)",
"title": "Type conversion",
"type": "boolean"
},
"notEquals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)",
"title": "Not Equals"
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the specified values.",
"markdownDescription": "Must not equal any of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionNotWithinPath": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notwithinpath)",
"title": "Case sensitive",
"type": "boolean"
},
"notWithinPath": {
"default": [],
"description": "The file path must not exist within the required paths.",
"items": {
"type": "string"
},
"markdownDescription": "The file path must not exist within the required paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notwithinpath)",
"title": "Not Within Path",
"type": "array",
"uniqueItems": true
}
},
"required": [
"notWithinPath"
],
"type": "object"
},
"selectorConditionSetOf": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#setof)",
"title": "Case sensitive",
"type": "boolean"
},
"setOf": {
"description": "Must include all of but only specified values.",
"markdownDescription": "Must include all of but only values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#setof)",
"title": "SetOf",
"type": "array"
}
},
"required": [
"setOf"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type to string.",
"markdownDescription": "Convert type to string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)",
"title": "Type conversion",
"type": "boolean"
},
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorConditionSubset": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Case sensitive",
"type": "boolean"
},
"subset": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Subset",
"type": "array"
},
"unique": {
"default": false,
"description": "Determines if each of the field values must be unique.",
"markdownDescription": "Determines if each of the field values must be unique. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Unique",
"type": "boolean"
}
},
"required": [
"subset"
],
"type": "object"
},
"selectorConditionVersion": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"includePrerelease": {
"default": false,
"description": "Determines if pre-release versions are included. By default, pre-release versions are not included.",
"markdownDescription": "Determines if pre-release versions are included. By default, pre-release versions are not included. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#version)",
"title": "Include pre-release",
"type": "boolean"
},
"version": {
"default": "",
"description": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range.",
"markdownDescription": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#version)",
"title": "Version",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"selectorConditionWithinPath": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#withinpath)",
"title": "Case sensitive",
"type": "boolean"
},
"withinPath": {
"default": [],
"description": "The file path must exist within the required paths.",
"items": {
"type": "string"
},
"markdownDescription": "The file path must exist within the required paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#withinpath)",
"title": "Within Path",
"type": "array",
"uniqueItems": true
}
},
"required": [
"withinPath"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValue": {
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "integer"
}
]
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#allof)",
"title": "All Of",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#anyof)",
"title": "Any Of",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
}
]
},
"selectorPropertiesString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
},
{
"$ref": "#/definitions/selectorPropertyType"
},
{
"$ref": "#/definitions/selectorPropertyName"
},
{
"$ref": "#/definitions/selectorPropertySource"
}
]
},
"selectorPropertyField": {
"properties": {
"field": {
"default": ".",
"description": "The object path of a field to compare.",
"markdownDescription": "The object path of a field to compare. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
},
"selectorPropertyName": {
"properties": {
"name": {
"default": ".",
"description": "The target name of the object.",
"markdownDescription": "The target name of the object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#name)",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
]
},
"selectorPropertySource": {
"properties": {
"source": {
"description": "The source of the object currently being processed by the pipeline.",
"markdownDescription": "The source of the object currently being processed by the pipeline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#source)",
"title": "Source",
"type": "string"
}
},
"required": [
"source"
]
},
"selectorPropertyType": {
"properties": {
"type": {
"default": ".",
"description": "The target type of the object.",
"markdownDescription": "The target type of the object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#type)",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "The specification for a selector.",
"markdownDescription": "The specification for a selector. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"description": "A condition is made up of one or more expressions that will determine if an object is selected by the selector.",
"markdownDescription": "A condition is made up of one or more [expressions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/) that will determine if an object is selected by the selector. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"title": "If",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
},
"suppressionGroup-v1": {
"description": "A PSRule Suppression Group",
"markdownDescription": "A PSRule Suppression Group. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_SuppressionGroups/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule SuppressionGroup resource.",
"enum": [
"SuppressionGroup"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/suppressionGroupSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "SuppressionGroup",
"type": "object"
},
"suppressionGroupSpec": {
"additionalProperties": false,
"description": "PSRule Suppression Group specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"rule": {
"description": "This only applies to rules that match the specified rule names",
"items": {
"type": "string"
},
"title": "Rule pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/rule-v1"
},
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
},
{
"$ref": "#/definitions/suppressionGroup-v1"
}
]
} | MIT | en |
microsoft/PSRule-vscode | f371033a62b80beacc67690e66f65ecf9297a629 | 2022-08-27T14:18:19 | .vscode/walkthrough.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"snippet": {
"additionalProperties": false,
"defaultSnippets": [
{
"body": {
"name": "",
"snippet": ""
},
"label": "New snippet"
}
],
"properties": {
"name": {
"type": "string"
},
"snippet": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"snippet"
],
"type": "object"
}
},
"items": {
"$ref": "#/definitions/snippet"
},
"type": "array"
} | MIT | en |
microsoft/PSRule-vscode | f40bcb3314c17ab5dafd00d05ccc56e261557883 | 2021-09-05T05:03:01 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"oneOf": [
{
"$ref": "#/definitions/execution-option"
}
],
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"oneOf": [
{
"$ref": "#/definitions/input-option"
}
],
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, and SupportLinks.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, and `SupportLinks`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, and RunInfo.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, and `RunInfo`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"Default"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputformat)",
"title": "Output format",
"type": "string"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputpath)",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"title": "Required modules",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Specifies rules to exclude by name.",
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Optionally filter to rules by name.",
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 8a950fa1ba965c5faf7c1cf518decd03d1ae2a66 | 2022-11-19T05:32:15 | schemas/PSRule-resources.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"description": "A schema for PSRule resources.",
"items": {
"anyOf": [
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/rule-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/baseline-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/moduleConfig-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/selector-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/suppressionGroup-v1"
}
]
},
"title": "PSRule resources",
"type": "array"
} | MIT | en |
microsoft/PSRule-vscode | 5a87252fd2bf5bf491244327efa635fb924141cc | 2024-01-01T06:27:53 | schemas/PSRule-lock.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "A schema for the PSRule lock file.",
"properties": {
"modules": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"version": {
"title": "Version",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"title": "Modules",
"type": "object"
}
},
"required": [
"modules"
],
"title": "PSRule lock",
"type": "object"
} | MIT | en |
microsoft/PSRule-vscode | 97db94c65cd652e1af4a9e94e112670553418be7 | 2022-02-10T14:38:21 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is `true`.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is `true`.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, and SupportLinks.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, and `SupportLinks`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, and RunInfo.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, and `RunInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"Default"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 81526e1156b5e7dededc2d01b5670c9baf3d3bc7 | 2023-03-23T14:19:56 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_AKS_CLUSTER_MINIMUM_VERSION": {
"default": "1.25.4",
"description": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified.",
"markdownDescription": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-rules/#aks-minimum-kubernetes-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "AKS cluster minimum version",
"type": "string"
},
"AZURE_BICEP_CHECK_TOOL": {
"default": false,
"description": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to true.",
"markdownDescription": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to `true`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#checking-bicep-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Checking Bicep Tool",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_BICEP_MINIMUM_VERSION": {
"default": "0.4.451",
"description": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is 0.4.451.",
"markdownDescription": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is `0.4.451`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#configuring-minimum-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep Minimum Version",
"type": "string"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown.\n\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"initialSessionState": {
"default": "BuiltIn",
"description": "Determines how the initial session state for executing PowerShell code is created. The default is BuiltIn.",
"enum": [
"BuiltIn",
"Minimal"
],
"markdownDescription": "Determines how the initial session state for executing PowerShell code is created. The default is `BuiltIn`.\n- When set to `BuiltIn` all built-in cmdlets are loaded.\n- When set to `Minimal` only cmdlets for hosting PowerShell will be loaded.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninitialsessionstate)",
"title": "Initial Session State",
"type": "string"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is true.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"ruleExcluded": {
"default": "Ignore",
"description": "Determines how to handle excluded rules. Regardless of the value, excluded rules are ignored. By default, rules are excluded silently. When set to Error, an error is thrown. When set to Warn, a warning is generated. When set to Debug, a message is written to the debug log.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle excluded rules.\n\nRegardless of the value, excluded rules are ignored. By default, rules are excluded silently.\n\n- When set to `Error`, an error is thrown.\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleexecluded)",
"title": "Rule excluded",
"type": "string"
},
"ruleSuppressed": {
"default": "Warn",
"description": "Determines how to handle suppressed rules. Regardless of the value, a suppressed rule is ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces suppressedRuleWarning. You do not need to configure both options. If suppressedRuleWarning is configured, it will override ruleSuppressed with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle suppressed rules.\n\nRegardless of the value, a suppressed rule is ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `suppressedRuleWarning`. You do not need to configure both options. If `suppressedRuleWarning` is configured, it will override `ruleSuppressed` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionrulesuppressed)",
"title": "Rule suppressed",
"type": "string"
},
"suppressedRuleWarning": {
"default": true,
"deprecated": true,
"description": "This option has been deprecated and will be removed from v3 in favor of ruleSuppressed. Enable or disable warnings for suppressed rules. The default is true.",
"markdownDescription": "This option has been deprecated and will be removed from v3 in favor of `ruleSuppressed`.\n\nEnable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules | DEPRECATED",
"type": "boolean"
},
"suppressionGroupExpired": {
"default": "Warn",
"description": "Determines how to handle expired suppression groups. Regardless of the value, an expired suppression group will be ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle expired suppression groups.\n\nRegardless of the value, an expired suppression group will be ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressiongroupexpired)",
"title": "Expired suppression groups",
"type": "string"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"ignoreUnchangedPath": {
"default": false,
"description": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed.",
"markdownDescription": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreunchangedpath)",
"title": "Ignore unchanged path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jobSummaryPath": {
"description": "The path to a job summary output file.",
"markdownDescription": "The path to a job summary output file. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjobsummarypath)",
"title": "Job Summary Path",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"baseRef": {
"description": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system.",
"markdownDescription": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositorybaseref)",
"title": "Base Reference",
"type": "string"
},
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 3170cc32b6d4f13811ebc19a4b5286fcd1a228eb | 2020-09-01T00:23:32 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"properties": {
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"properties": {
"binding": {
"$ref": "#/definitions/bindingOption"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Baseline",
"type": "object"
},
"bindingOption": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"title": "Name separator",
"type": "string"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"description": "A set of key/ value configuration options for rules.",
"title": "Configuration values",
"type": "object"
},
"moduleConfig": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/bindingOption"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
}
},
"title": "ModuleConfig",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"title": "Annotations",
"type": "object"
},
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML language files.",
"oneOf": [
{
"$ref": "#/definitions/baseline"
},
{
"$ref": "#/definitions/moduleConfig"
}
],
"title": "PSRule language"
} | MIT | en |
microsoft/PSRule-vscode | e07b92cda71b25a3197852f16d523713569054d5 | 2022-03-08T05:48:48 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"description": "Rules to exclude by name from the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Rules to include by name in the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"baseline": {
"$ref": "#/definitions/resourceName",
"description": "The name of a baseline to use.",
"markdownDescription": "The name of a baseline to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#rulebaseline)",
"title": "Baseline",
"type": "string"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"properties": {
"obsolete": {
"default": false,
"description": "A common annotation that flags the resource as obsolete.",
"title": "Obsolete",
"type": "boolean"
}
},
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"tags": {
"$ref": "#/definitions/resourceTags"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"resourceTags": {
"additionalProperties": {
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Tag key/ value"
}
],
"description": "Additional indexed key/ value pairs for the resource.",
"title": "Tags",
"type": "object"
},
"rule-v1": {
"description": "A rule resource.",
"markdownDescription": "A rule resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A rule resource.",
"enum": [
"Rule"
],
"markdownDescription": "A rule resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ruleMetadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/ruleSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Rule",
"type": "object"
},
"ruleMetadata": {
"description": "Additional information to identify the resource.",
"properties": {
"alias": {
"description": "Alternative names this resource is known by.",
"items": {
"$ref": "#/definitions/resourceName",
"description": "An alternative name.",
"title": "Alias",
"type": "string"
},
"title": "Aliases",
"type": "array",
"uniqueItems": true
},
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"ref": {
"$ref": "#/definitions/resourceName",
"description": "An optional stable opaque identifier of this resource for lookup. This must be unique if set.",
"title": "Reference"
},
"tags": {
"$ref": "#/definitions/resourceTags"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"ruleSpec": {
"additionalProperties": false,
"description": "The specification for the rule.",
"markdownDescription": "The specification for the rule. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"properties": {
"condition": {
"$ref": "#/definitions/selectorExpression",
"description": "A condition is made up of one or more expressions that will determine if the rule passes or fails.",
"markdownDescription": "A condition is made up of one or more [expressions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/) that will determine if the rule passes or fails. [See help](https://microsoft.github.io/PSRule/v2/authoring/writing-rules/)",
"title": "Condition",
"type": "object"
},
"level": {
"default": "Error",
"description": "If the rule fails, how serious is the result. By default this is set to Error.",
"enum": [
"Error",
"Warning",
"Information"
],
"markdownDescription": "If the rule fails, how serious is the result. By default this is set to `Error`. [See help](https://microsoft.github.io/PSRule/v2/authoring/writing-rules/)",
"title": "Level",
"type": "string"
},
"type": {
"description": "This rule only applies to objects that match the specifies types.",
"items": {
"type": "string"
},
"title": "Type pre-condition",
"type": "array",
"uniqueItems": true
},
"with": {
"description": "This rule only applies to objects that match the specified selectors.",
"items": {
"type": "string"
},
"title": "Selector pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"condition"
],
"title": "Spec",
"type": "object"
},
"selector-v1": {
"description": "A selector resource.",
"markdownDescription": "A selector resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionSetOf"
},
{
"$ref": "#/definitions/selectorConditionSubset"
},
{
"$ref": "#/definitions/selectorConditionCount"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsArray"
},
{
"$ref": "#/definitions/selectorConditionIsBoolean"
},
{
"$ref": "#/definitions/selectorConditionIsDateTime"
},
{
"$ref": "#/definitions/selectorConditionIsInteger"
},
{
"$ref": "#/definitions/selectorConditionIsNumeric"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
},
{
"$ref": "#/definitions/selectorConditionHasSchema"
},
{
"$ref": "#/definitions/selectorConditionVersion"
},
{
"$ref": "#/definitions/selectorConditionHasDefault"
},
{
"$ref": "#/definitions/selectorConditionWithinPath"
},
{
"$ref": "#/definitions/selectorConditionNotWithinPath"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)",
"title": "Case sensitive",
"type": "boolean"
},
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)",
"title": "Contains"
},
"convert": {
"default": false,
"description": "Convert type to string.",
"markdownDescription": "Convert type to string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)",
"title": "Type conversion",
"type": "boolean"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionCount": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"count": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#count)",
"minimum": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type to string.",
"markdownDescription": "Convert type to string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)",
"title": "Type conversion",
"type": "boolean"
},
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive. Only applies to string values.",
"markdownDescription": "Determines if comparing values is case-sensitive. Only applies to string values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type of compared operand.",
"markdownDescription": "Convert type of compared operand. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)",
"title": "Type conversion",
"type": "boolean"
},
"equals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)",
"title": "Equals"
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasDefault": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasdefault)",
"title": "Case sensitive",
"type": "boolean"
},
"hasDefault": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "The field must either not exist or be set to the configured value.",
"markdownDescription": "The field must either not exist or be set to the configured value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasdefault)",
"title": "Has Default"
}
},
"required": [
"hasDefault"
],
"type": "object"
},
"selectorConditionHasSchema": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing schemas is case-sensitive.",
"markdownDescription": "Determines if comparing schemas is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Case sensitive",
"type": "boolean"
},
"hasSchema": {
"default": [],
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"items": {
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"minLength": 1,
"title": "Has schema",
"type": "string"
},
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Has schema",
"type": "array",
"uniqueItems": true
},
"ignoreScheme": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Ignore scheme",
"type": "boolean"
}
},
"required": [
"hasSchema"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"in": {
"description": "Must equal one of the specified values.",
"markdownDescription": "Must equal one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsArray": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isArray": {
"description": "Must be an array type.",
"markdownDescription": "Must be an array type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isarray)",
"title": "Is array",
"type": "boolean"
}
},
"required": [
"isArray"
],
"type": "object"
},
"selectorConditionIsBoolean": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to boolean.",
"markdownDescription": "Convert type to boolean. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isboolean)",
"title": "Type conversion",
"type": "boolean"
},
"isBoolean": {
"description": "Must be a boolean type.",
"markdownDescription": "Must be a boolean type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isboolean)",
"title": "Is boolean",
"type": "boolean"
}
},
"required": [
"isBoolean"
],
"type": "object"
},
"selectorConditionIsDateTime": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to datetime.",
"markdownDescription": "Convert type to datetime. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isdatetime)",
"title": "Type conversion",
"type": "boolean"
},
"isDateTime": {
"description": "Must be a datetime type.",
"markdownDescription": "Must be a datetime type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isdatetime)",
"title": "Is datetime",
"type": "boolean"
}
},
"required": [
"isDateTime"
],
"type": "object"
},
"selectorConditionIsInteger": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to integer.",
"markdownDescription": "Convert type to integer. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isinteger)",
"title": "Type conversion",
"type": "boolean"
},
"isInteger": {
"description": "Must be an integer type.",
"markdownDescription": "Must be an integer type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isinteger)",
"title": "Is integer",
"type": "boolean"
}
},
"required": [
"isInteger"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsNumeric": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to numeric.",
"markdownDescription": "Convert type to numeric. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isnumeric)",
"title": "Type conversion",
"type": "boolean"
},
"isNumeric": {
"description": "Must be a numeric type.",
"markdownDescription": "Must be a numeric type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isnumeric)",
"title": "Is numeric",
"type": "boolean"
}
},
"required": [
"isNumeric"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive. Only applies to string values.",
"markdownDescription": "Determines if comparing values is case-sensitive. Only applies to string values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type of compared operand.",
"markdownDescription": "Convert type of compared operand. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)",
"title": "Type conversion",
"type": "boolean"
},
"notEquals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)",
"title": "Not Equals"
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the specified values.",
"markdownDescription": "Must not equal any of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionNotWithinPath": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notwithinpath)",
"title": "Case sensitive",
"type": "boolean"
},
"notWithinPath": {
"default": [],
"description": "The file path must not exist within the required paths.",
"items": {
"type": "string"
},
"markdownDescription": "The file path must not exist within the required paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notwithinpath)",
"title": "Not Within Path",
"type": "array",
"uniqueItems": true
}
},
"required": [
"notWithinPath"
],
"type": "object"
},
"selectorConditionSetOf": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#setof)",
"title": "Case sensitive",
"type": "boolean"
},
"setOf": {
"description": "Must include all of but only specified values.",
"markdownDescription": "Must include all of but only values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#setof)",
"title": "SetOf",
"type": "array"
}
},
"required": [
"setOf"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type to string.",
"markdownDescription": "Convert type to string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)",
"title": "Type conversion",
"type": "boolean"
},
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorConditionSubset": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Case sensitive",
"type": "boolean"
},
"subset": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Subset",
"type": "array"
},
"unique": {
"default": false,
"description": "Determines if each of the field values must be unique.",
"markdownDescription": "Determines if each of the field values must be unique. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Unique",
"type": "boolean"
}
},
"required": [
"subset"
],
"type": "object"
},
"selectorConditionVersion": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"includePrerelease": {
"default": false,
"description": "Determines if pre-release versions are included. By default, pre-release versions are not included.",
"markdownDescription": "Determines if pre-release versions are included. By default, pre-release versions are not included. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#version)",
"title": "Include pre-release",
"type": "boolean"
},
"version": {
"default": "",
"description": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range.",
"markdownDescription": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#version)",
"title": "Version",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"selectorConditionWithinPath": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#withinpath)",
"title": "Case sensitive",
"type": "boolean"
},
"withinPath": {
"default": [],
"description": "The file path must exist within the required paths.",
"items": {
"type": "string"
},
"markdownDescription": "The file path must exist within the required paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#withinpath)",
"title": "Within Path",
"type": "array",
"uniqueItems": true
}
},
"required": [
"withinPath"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValue": {
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "integer"
}
]
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#allof)",
"title": "All Of",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#anyof)",
"title": "Any Of",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
}
]
},
"selectorPropertiesString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
},
{
"$ref": "#/definitions/selectorPropertyType"
},
{
"$ref": "#/definitions/selectorPropertyName"
},
{
"$ref": "#/definitions/selectorPropertySource"
}
]
},
"selectorPropertyField": {
"properties": {
"field": {
"default": ".",
"description": "The object path of a field to compare.",
"markdownDescription": "The object path of a field to compare. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
},
"selectorPropertyName": {
"properties": {
"name": {
"default": ".",
"description": "The target name of the object.",
"markdownDescription": "The target name of the object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#name)",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
]
},
"selectorPropertySource": {
"properties": {
"source": {
"description": "The source of the object currently being processed by the pipeline.",
"markdownDescription": "The source of the object currently being processed by the pipeline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#source)",
"title": "Source",
"type": "string"
}
},
"required": [
"source"
]
},
"selectorPropertyType": {
"properties": {
"type": {
"default": ".",
"description": "The target type of the object.",
"markdownDescription": "The target type of the object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#type)",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "The specification for a selector.",
"markdownDescription": "The specification for a selector. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"description": "A condition is made up of one or more expressions that will determine if an object is selected by the selector.",
"markdownDescription": "A condition is made up of one or more [expressions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/) that will determine if an object is selected by the selector. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"title": "If",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
},
"suppressionGroup-v1": {
"description": "A PSRule Suppression Group",
"markdownDescription": "A PSRule Suppression Group. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_SuppressionGroups/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule SuppressionGroup resource.",
"enum": [
"SuppressionGroup"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/suppressionGroupSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "SuppressionGroup",
"type": "object"
},
"suppressionGroupSpec": {
"additionalProperties": false,
"description": "PSRule Suppression Group specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"rule": {
"description": "This only applies to rules that match the specified rule names",
"items": {
"type": "string"
},
"title": "Rule pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/rule-v1"
},
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
},
{
"$ref": "#/definitions/suppressionGroup-v1"
}
]
} | MIT | en |
microsoft/PSRule-vscode | c4627ddc334ab7624f31941ad0f8d2efd1b51e31 | 2023-07-07T07:26:07 | .vscode/walkthrough.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"snippet": {
"additionalProperties": false,
"defaultSnippets": [
{
"body": {
"name": "",
"snippet": ""
},
"label": "New snippet"
}
],
"properties": {
"name": {
"type": "string"
},
"snippet": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"snippet"
],
"type": "object"
}
},
"items": {
"$ref": "#/definitions/snippet"
},
"type": "array"
} | MIT | en |
microsoft/PSRule-vscode | a3ab1ed61e3024264dcc103330ff6be5481f2929 | 2022-09-11T08:37:10 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to `Warn`, a warning is generated. When set to `Ignore`, no output will be displayed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"initialSessionState": {
"default": "BuiltIn",
"description": "Determines how the initial session state for executing PowerShell code is created. The default is BuiltIn.",
"enum": [
"BuiltIn",
"Minimal"
],
"markdownDescription": "Determines how the initial session state for executing PowerShell code is created. The default is `BuiltIn`.\n- When set to `BuiltIn` all built-in cmdlets are loaded.\n- When set to `Minimal` only cmdlets for hosting PowerShell will be loaded.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninitialsessionstate)",
"title": "Initial Session State",
"type": "string"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is true.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is true.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 8ca688b057543b9b78211059ace95e740cfb0830 | 2023-10-17T08:30:35 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-option": {
"additionalProperties": false,
"description": "Options that configure baselines.",
"properties": {
"group": {
"additionalProperties": {
"description": "Maps a group name to a baseline.",
"title": "Group mapping",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Group}": "${2:Baseline}"
},
"label": "Baseline group"
}
],
"description": "Configure baseline group names.",
"title": "Baseline group",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_AKS_CLUSTER_MINIMUM_VERSION": {
"default": "1.25.4",
"description": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified.",
"markdownDescription": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-rules/#aks-minimum-kubernetes-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "AKS cluster minimum version",
"type": "string"
},
"AZURE_BICEP_CHECK_TOOL": {
"default": false,
"description": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to true.",
"markdownDescription": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to `true`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#checking-bicep-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Checking Bicep Tool",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_BICEP_MINIMUM_VERSION": {
"default": "0.4.451",
"description": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is 0.4.451.",
"markdownDescription": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is `0.4.451`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#configuring-minimum-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep Minimum Version",
"type": "string"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReference": {
"default": "Warn",
"description": "Determines how to handle when an alias to a resource is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle when an alias to a resource is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreference)",
"title": "Alias references",
"type": "string"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown.\n\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"hashAlgorithm": {
"default": "SHA512",
"description": "Configures the hashing algorithm used by the PSRule runtime. By default, SHA512 is used.",
"enum": [
"SHA512",
"SHA384",
"SHA256"
],
"markdownDescription": "Configures the hashing algorithm used by the PSRule runtime.\n\nBy default, `SHA512` is used.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionhashalgorithm)",
"title": "Hash Algorithm",
"type": "string"
},
"initialSessionState": {
"default": "BuiltIn",
"description": "Determines how the initial session state for executing PowerShell code is created. The default is BuiltIn.",
"enum": [
"BuiltIn",
"Minimal"
],
"markdownDescription": "Determines how the initial session state for executing PowerShell code is created. The default is `BuiltIn`.\n- When set to `BuiltIn` all built-in cmdlets are loaded.\n- When set to `Minimal` only cmdlets for hosting PowerShell will be loaded.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninitialsessionstate)",
"title": "Initial Session State",
"type": "string"
},
"invariantCulture": {
"default": "Warn",
"description": "Determines how to report when an invariant culture is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report when an invariant culture is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculture)",
"title": "Invariant culture",
"type": "string"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"ruleExcluded": {
"default": "Ignore",
"description": "Determines how to handle excluded rules. Regardless of the value, excluded rules are ignored. By default, rules are excluded silently. When set to Error, an error is thrown. When set to Warn, a warning is generated. When set to Debug, a message is written to the debug log.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle excluded rules.\n\nRegardless of the value, excluded rules are ignored. By default, rules are excluded silently.\n\n- When set to `Error`, an error is thrown.\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleexcluded)",
"title": "Rule excluded",
"type": "string"
},
"ruleInconclusive": {
"default": "Warn",
"description": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleinconclusive)",
"title": "Inconclusive rules",
"type": "string"
},
"ruleSuppressed": {
"default": "Warn",
"description": "Determines how to handle suppressed rules. Regardless of the value, a suppressed rule is ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle suppressed rules.\n\nRegardless of the value, a suppressed rule is ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionrulesuppressed)",
"title": "Rule suppressed",
"type": "string"
},
"suppressionGroupExpired": {
"default": "Warn",
"description": "Determines how to handle expired suppression groups. Regardless of the value, an expired suppression group will be ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle expired suppression groups.\n\nRegardless of the value, an expired suppression group will be ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressiongroupexpired)",
"title": "Expired suppression groups",
"type": "string"
},
"unprocessedObject": {
"default": "Warn",
"description": "Determines how to report objects that are not processed by any rule. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report objects that are not processed by any rule. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionunprocessedobject)",
"title": "Unprocessed object",
"type": "string"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"ignoreUnchangedPath": {
"default": false,
"description": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed.",
"markdownDescription": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreunchangedpath)",
"title": "Ignore unchanged path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"baseline": {
"$ref": "#/definitions/baseline-option",
"type": "object"
},
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jobSummaryPath": {
"description": "The path to a job summary output file.",
"markdownDescription": "The path to a job summary output file. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjobsummarypath)",
"title": "Job Summary Path",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"baseRef": {
"description": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system.",
"markdownDescription": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositorybaseref)",
"title": "Base Reference",
"type": "string"
},
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "PSRule options configuration file.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 0db33ac189a584a058d6de7047c524b8f35096e8 | 2022-01-17T07:35:33 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"baseline": {
"$ref": "#/definitions/rule-names",
"description": "The name of a baseline to use.",
"markdownDescription": "The name of a baseline to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#rulebaseline)",
"title": "Baseline",
"type": "string"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"title": "Annotations",
"type": "object"
},
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"title": "Tags",
"type": "object"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-v1": {
"description": "A PSRule Rule.",
"markdownDescription": "A PSRule Rule. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Rules.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Rule resource.",
"enum": [
"Rule"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/ruleSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Rule",
"type": "object"
},
"ruleSpec": {
"additionalProperties": false,
"description": "PSRule rule specification.",
"properties": {
"condition": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"type": {
"description": "This rule only applies to objects that match the specifies types.",
"items": {
"type": "string"
},
"title": "Type pre-condition",
"type": "array",
"uniqueItems": true
},
"with": {
"description": "This rule only applies to objects that match the specified selectors.",
"items": {
"type": "string"
},
"title": "Selector pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"condition"
],
"title": "Spec",
"type": "object"
},
"selector-v1": {
"description": "A PSRule Selector.",
"markdownDescription": "A PSRule Selector. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionSetOf"
},
{
"$ref": "#/definitions/selectorConditionSubset"
},
{
"$ref": "#/definitions/selectorConditionCount"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
},
{
"$ref": "#/definitions/selectorConditionHasSchema"
},
{
"$ref": "#/definitions/selectorConditionVersion"
},
{
"$ref": "#/definitions/selectorConditionHasDefault"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#contains)",
"title": "Contains"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionCount": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"count": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#count)",
"minimum": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"equals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals"
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasDefault": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasdefault)",
"title": "Case sensitive",
"type": "boolean"
},
"hasDefault": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "The field must either not exist or be set to the configured value.",
"markdownDescription": "The field must either not exist or be set to the configured value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasdefault)",
"title": "Has Default"
}
},
"required": [
"hasDefault"
],
"type": "object"
},
"selectorConditionHasSchema": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing schemas is case-sensitive.",
"markdownDescription": "Determines if comparing schemas is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"title": "Case sensitive",
"type": "boolean"
},
"hasSchema": {
"default": [],
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"items": {
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"minLength": 1,
"title": "Has schema",
"type": "string"
},
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"title": "Has schema",
"type": "array",
"uniqueItems": true
},
"ignoreScheme": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"title": "Ignore scheme",
"type": "boolean"
}
},
"required": [
"hasSchema"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"in": {
"description": "Must equal one the values.",
"markdownDescription": "Must equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notEquals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals"
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the values.",
"markdownDescription": "Must not equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionSetOf": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#setof)",
"title": "Case sensitive",
"type": "boolean"
},
"setOf": {
"description": "Must include all of but only specified values.",
"markdownDescription": "Must include all of but only values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#setof)",
"title": "SetOf",
"type": "array"
}
},
"required": [
"setOf"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorConditionSubset": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Case sensitive",
"type": "boolean"
},
"subset": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Subset",
"type": "array"
},
"unique": {
"default": false,
"description": "Determines if each of the field values must be unique.",
"markdownDescription": "Determines if each of the field values must be unique. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Unique",
"type": "boolean"
}
},
"required": [
"subset"
],
"type": "object"
},
"selectorConditionVersion": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"includePrerelease": {
"default": false,
"description": "Determines if pre-release versions are included. By default, pre-release versions are not included.",
"markdownDescription": "Determines if pre-release versions are included. By default, pre-release versions are not included. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#version)",
"title": "Include pre-release",
"type": "boolean"
},
"version": {
"default": "",
"description": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range.",
"markdownDescription": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#version)",
"title": "Version",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValue": {
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "integer"
}
]
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#allof)",
"title": "All Of",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#anyof)",
"title": "Any Of",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
}
]
},
"selectorPropertiesString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
},
{
"$ref": "#/definitions/selectorPropertyType"
},
{
"$ref": "#/definitions/selectorPropertyName"
}
]
},
"selectorPropertyField": {
"properties": {
"field": {
"default": ".",
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
},
"selectorPropertyName": {
"properties": {
"name": {
"default": ".",
"description": "The target name of the object.",
"markdownDescription": "The target name of the object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#name)",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
]
},
"selectorPropertyType": {
"properties": {
"type": {
"default": ".",
"description": "The target type of the object.",
"markdownDescription": "The target type of the object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#type)",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "PSRule selector specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/rule-v1"
},
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
}
]
} | MIT | en |
microsoft/PSRule-vscode | 28a8f7cf127e9007ddd187ac376d83982a007c11 | 2023-04-29T10:14:27 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_AKS_CLUSTER_MINIMUM_VERSION": {
"default": "1.25.4",
"description": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified.",
"markdownDescription": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-rules/#aks-minimum-kubernetes-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "AKS cluster minimum version",
"type": "string"
},
"AZURE_BICEP_CHECK_TOOL": {
"default": false,
"description": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to true.",
"markdownDescription": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to `true`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#checking-bicep-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Checking Bicep Tool",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_BICEP_MINIMUM_VERSION": {
"default": "0.4.451",
"description": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is 0.4.451.",
"markdownDescription": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is `0.4.451`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#configuring-minimum-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep Minimum Version",
"type": "string"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReference": {
"default": "Warn",
"description": "Determines how to handle when an alias to a resource is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces aliasReferenceWarning. You do not need to configure both options. If aliasReferenceWarning is configured, it will override aliasReference with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle when an alias to a resource is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `aliasReferenceWarning`. You do not need to configure both options. If `aliasReferenceWarning` is configured, it will override `aliasReference` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreference)",
"title": "Alias references",
"type": "string"
},
"aliasReferenceWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases | DEPRECATED",
"type": "boolean"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown.\n\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"inconclusiveWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules | DEPRECATED",
"type": "boolean"
},
"initialSessionState": {
"default": "BuiltIn",
"description": "Determines how the initial session state for executing PowerShell code is created. The default is BuiltIn.",
"enum": [
"BuiltIn",
"Minimal"
],
"markdownDescription": "Determines how the initial session state for executing PowerShell code is created. The default is `BuiltIn`.\n- When set to `BuiltIn` all built-in cmdlets are loaded.\n- When set to `Minimal` only cmdlets for hosting PowerShell will be loaded.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninitialsessionstate)",
"title": "Initial Session State",
"type": "string"
},
"invariantCulture": {
"default": "Warn",
"description": "Determines how to report when an invariant culture is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces invariantCultureWarning. You do not need to configure both options. If invariantCultureWarning is configured, it will override invariantCulture with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report when an invariant culture is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `invariantCultureWarning`. You do not need to configure both options. If `invariantCultureWarning` is configured, it will override `invariantCulture` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculture)",
"title": "Invariant culture",
"type": "string"
},
"invariantCultureWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warning when invariant culture is used. The default is true.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture | DEPRECATED",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects | DEPRECATED",
"type": "boolean"
},
"ruleExcluded": {
"default": "Ignore",
"description": "Determines how to handle excluded rules. Regardless of the value, excluded rules are ignored. By default, rules are excluded silently. When set to Error, an error is thrown. When set to Warn, a warning is generated. When set to Debug, a message is written to the debug log.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle excluded rules.\n\nRegardless of the value, excluded rules are ignored. By default, rules are excluded silently.\n\n- When set to `Error`, an error is thrown.\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleexcluded)",
"title": "Rule excluded",
"type": "string"
},
"ruleInconclusive": {
"default": "Warn",
"description": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces inconclusiveWarning. You do not need to configure both options. If inconclusiveWarning is configured, it will override ruleInconclusive with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `inconclusiveWarning`. You do not need to configure both options. If `inconclusiveWarning` is configured, it will override `ruleInconclusive` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleinconclusive)",
"title": "Inconclusive rules",
"type": "string"
},
"ruleSuppressed": {
"default": "Warn",
"description": "Determines how to handle suppressed rules. Regardless of the value, a suppressed rule is ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces suppressedRuleWarning. You do not need to configure both options. If suppressedRuleWarning is configured, it will override ruleSuppressed with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle suppressed rules.\n\nRegardless of the value, a suppressed rule is ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `suppressedRuleWarning`. You do not need to configure both options. If `suppressedRuleWarning` is configured, it will override `ruleSuppressed` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionrulesuppressed)",
"title": "Rule suppressed",
"type": "string"
},
"suppressedRuleWarning": {
"default": true,
"deprecated": true,
"description": "This option has been deprecated and will be removed from v3 in favor of ruleSuppressed. Enable or disable warnings for suppressed rules. The default is true.",
"markdownDescription": "This option has been deprecated and will be removed from v3 in favor of `ruleSuppressed`.\n\nEnable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules | DEPRECATED",
"type": "boolean"
},
"suppressionGroupExpired": {
"default": "Warn",
"description": "Determines how to handle expired suppression groups. Regardless of the value, an expired suppression group will be ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle expired suppression groups.\n\nRegardless of the value, an expired suppression group will be ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressiongroupexpired)",
"title": "Expired suppression groups",
"type": "string"
},
"unprocessedObject": {
"default": "Warn",
"description": "Determines how to report objects that are not processed by any rule. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces notProcessedWarning. You do not need to configure both options. If notProcessedWarning is configured, it will override unprocessedObject with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report objects that are not processed by any rule. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `notProcessedWarning`. You do not need to configure both options. If `notProcessedWarning` is configured, it will override `unprocessedObject` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionunprocessedobject)",
"title": "Unprocessed object",
"type": "string"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"ignoreUnchangedPath": {
"default": false,
"description": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed.",
"markdownDescription": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreunchangedpath)",
"title": "Ignore unchanged path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jobSummaryPath": {
"description": "The path to a job summary output file.",
"markdownDescription": "The path to a job summary output file. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjobsummarypath)",
"title": "Job Summary Path",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"baseRef": {
"description": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system.",
"markdownDescription": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositorybaseref)",
"title": "Base Reference",
"type": "string"
},
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "PSRule options configuration file.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 12276357eb44fcf931b5b32becb1bf4b58b7c8a7 | 2019-09-22T01:50:03 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline": {
"additionalProperties": false,
"properties": {
"kind": {
"description": "The type of PSRule resource.",
"enum": [
"Baseline"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baseline-spec",
"type": "object"
}
},
"required": [
"kind",
"metadata",
"spec"
],
"type": "object"
},
"baseline-spec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"properties": {
"binding": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"title": "Ignore case",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"description": "Baseline specific configuration options.",
"title": "Configuration",
"type": "object",
"uniqueItems": true
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"type": "string"
},
"description": "Rules to include by tag in the baseline.",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Baseline",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML language files.",
"oneOf": [
{
"$ref": "#/definitions/baseline"
}
],
"title": "PSRule language"
} | MIT | en |
microsoft/PSRule-vscode | e07b92cda71b25a3197852f16d523713569054d5 | 2022-03-08T05:48:48 | schemas/PSRule-resources.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"description": "A schema for PSRule resources.",
"items": {
"anyOf": [
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/rule-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/baseline-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/moduleConfig-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/selector-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/suppressionGroup-v1"
}
]
},
"title": "PSRule resources",
"type": "array"
} | MIT | en |
microsoft/PSRule-vscode | dbbfb5702e0095fe24ec6564c0b0e03ec2b3df50 | 2022-03-20T14:40:00 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"description": "Rules to exclude by name from the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Rules to include by name in the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"baseline": {
"$ref": "#/definitions/resourceName",
"description": "The name of a baseline to use.",
"markdownDescription": "The name of a baseline to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#rulebaseline)",
"title": "Baseline",
"type": "string"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"properties": {
"obsolete": {
"default": false,
"description": "A common annotation that flags the resource as obsolete.",
"title": "Obsolete",
"type": "boolean"
}
},
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"tags": {
"$ref": "#/definitions/resourceTags"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"resourceTags": {
"additionalProperties": {
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Tag key/ value"
}
],
"description": "Additional indexed key/ value pairs for the resource.",
"title": "Tags",
"type": "object"
},
"rule-v1": {
"description": "A rule resource.",
"markdownDescription": "A rule resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A rule resource.",
"enum": [
"Rule"
],
"markdownDescription": "A rule resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ruleMetadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/ruleSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Rule",
"type": "object"
},
"ruleMetadata": {
"description": "Additional information to identify the resource.",
"properties": {
"alias": {
"description": "Alternative names this resource is known by.",
"items": {
"$ref": "#/definitions/resourceName",
"description": "An alternative name.",
"title": "Alias",
"type": "string"
},
"title": "Aliases",
"type": "array",
"uniqueItems": true
},
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"ref": {
"$ref": "#/definitions/resourceName",
"description": "An optional stable opaque identifier of this resource for lookup. This must be unique if set.",
"title": "Reference"
},
"tags": {
"$ref": "#/definitions/resourceTags"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"ruleSpec": {
"additionalProperties": false,
"description": "The specification for the rule.",
"markdownDescription": "The specification for the rule. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"properties": {
"condition": {
"$ref": "#/definitions/selectorExpression",
"description": "A condition is made up of one or more expressions that will determine if the rule passes or fails.",
"markdownDescription": "A condition is made up of one or more [expressions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/) that will determine if the rule passes or fails. [See help](https://microsoft.github.io/PSRule/v2/authoring/writing-rules/)",
"title": "Condition",
"type": "object"
},
"level": {
"default": "Error",
"description": "If the rule fails, how serious is the result. By default this is set to Error.",
"enum": [
"Error",
"Warning",
"Information"
],
"markdownDescription": "If the rule fails, how serious is the result. By default this is set to `Error`. [See help](https://microsoft.github.io/PSRule/v2/authoring/writing-rules/)",
"title": "Level",
"type": "string"
},
"type": {
"description": "This rule only applies to objects that match the specifies types.",
"items": {
"type": "string"
},
"title": "Type pre-condition",
"type": "array",
"uniqueItems": true
},
"with": {
"description": "This rule only applies to objects that match the specified selectors.",
"items": {
"type": "string"
},
"title": "Selector pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"condition"
],
"title": "Spec",
"type": "object"
},
"selector-v1": {
"description": "A selector resource.",
"markdownDescription": "A selector resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionSetOf"
},
{
"$ref": "#/definitions/selectorConditionSubset"
},
{
"$ref": "#/definitions/selectorConditionCount"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsArray"
},
{
"$ref": "#/definitions/selectorConditionIsBoolean"
},
{
"$ref": "#/definitions/selectorConditionIsDateTime"
},
{
"$ref": "#/definitions/selectorConditionIsInteger"
},
{
"$ref": "#/definitions/selectorConditionIsNumeric"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
},
{
"$ref": "#/definitions/selectorConditionHasSchema"
},
{
"$ref": "#/definitions/selectorConditionVersion"
},
{
"$ref": "#/definitions/selectorConditionHasDefault"
},
{
"$ref": "#/definitions/selectorConditionWithinPath"
},
{
"$ref": "#/definitions/selectorConditionNotWithinPath"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)",
"title": "Case sensitive",
"type": "boolean"
},
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)",
"title": "Contains"
},
"convert": {
"default": false,
"description": "Convert type to string.",
"markdownDescription": "Convert type to string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)",
"title": "Type conversion",
"type": "boolean"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionCount": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"count": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#count)",
"minimum": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type to string.",
"markdownDescription": "Convert type to string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)",
"title": "Type conversion",
"type": "boolean"
},
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive. Only applies to string values.",
"markdownDescription": "Determines if comparing values is case-sensitive. Only applies to string values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type of compared operand.",
"markdownDescription": "Convert type of compared operand. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)",
"title": "Type conversion",
"type": "boolean"
},
"equals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)",
"title": "Equals"
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type of compared operand.",
"markdownDescription": "Convert type of compared operand. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#less)",
"title": "Type conversion",
"type": "boolean"
},
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type of compared operand.",
"markdownDescription": "Convert type of compared operand. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#less)",
"title": "Type conversion",
"type": "boolean"
},
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasDefault": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasdefault)",
"title": "Case sensitive",
"type": "boolean"
},
"hasDefault": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "The field must either not exist or be set to the configured value.",
"markdownDescription": "The field must either not exist or be set to the configured value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasdefault)",
"title": "Has Default"
}
},
"required": [
"hasDefault"
],
"type": "object"
},
"selectorConditionHasSchema": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing schemas is case-sensitive.",
"markdownDescription": "Determines if comparing schemas is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Case sensitive",
"type": "boolean"
},
"hasSchema": {
"default": [],
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"items": {
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"minLength": 1,
"title": "Has schema",
"type": "string"
},
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Has schema",
"type": "array",
"uniqueItems": true
},
"ignoreScheme": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Ignore scheme",
"type": "boolean"
}
},
"required": [
"hasSchema"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"in": {
"description": "Must equal one of the specified values.",
"markdownDescription": "Must equal one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsArray": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isArray": {
"description": "Must be an array type.",
"markdownDescription": "Must be an array type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isarray)",
"title": "Is array",
"type": "boolean"
}
},
"required": [
"isArray"
],
"type": "object"
},
"selectorConditionIsBoolean": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to boolean.",
"markdownDescription": "Convert type to boolean. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isboolean)",
"title": "Type conversion",
"type": "boolean"
},
"isBoolean": {
"description": "Must be a boolean type.",
"markdownDescription": "Must be a boolean type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isboolean)",
"title": "Is boolean",
"type": "boolean"
}
},
"required": [
"isBoolean"
],
"type": "object"
},
"selectorConditionIsDateTime": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to datetime.",
"markdownDescription": "Convert type to datetime. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isdatetime)",
"title": "Type conversion",
"type": "boolean"
},
"isDateTime": {
"description": "Must be a datetime type.",
"markdownDescription": "Must be a datetime type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isdatetime)",
"title": "Is datetime",
"type": "boolean"
}
},
"required": [
"isDateTime"
],
"type": "object"
},
"selectorConditionIsInteger": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to integer.",
"markdownDescription": "Convert type to integer. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isinteger)",
"title": "Type conversion",
"type": "boolean"
},
"isInteger": {
"description": "Must be an integer type.",
"markdownDescription": "Must be an integer type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isinteger)",
"title": "Is integer",
"type": "boolean"
}
},
"required": [
"isInteger"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsNumeric": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to numeric.",
"markdownDescription": "Convert type to numeric. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isnumeric)",
"title": "Type conversion",
"type": "boolean"
},
"isNumeric": {
"description": "Must be a numeric type.",
"markdownDescription": "Must be a numeric type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isnumeric)",
"title": "Is numeric",
"type": "boolean"
}
},
"required": [
"isNumeric"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type of compared operand.",
"markdownDescription": "Convert type of compared operand. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#less)",
"title": "Type conversion",
"type": "boolean"
},
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type of compared operand.",
"markdownDescription": "Convert type of compared operand. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#less)",
"title": "Type conversion",
"type": "boolean"
},
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive. Only applies to string values.",
"markdownDescription": "Determines if comparing values is case-sensitive. Only applies to string values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type of compared operand.",
"markdownDescription": "Convert type of compared operand. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)",
"title": "Type conversion",
"type": "boolean"
},
"notEquals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)",
"title": "Not Equals"
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the specified values.",
"markdownDescription": "Must not equal any of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionNotWithinPath": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notwithinpath)",
"title": "Case sensitive",
"type": "boolean"
},
"notWithinPath": {
"default": [],
"description": "The file path must not exist within the required paths.",
"items": {
"type": "string"
},
"markdownDescription": "The file path must not exist within the required paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notwithinpath)",
"title": "Not Within Path",
"type": "array",
"uniqueItems": true
}
},
"required": [
"notWithinPath"
],
"type": "object"
},
"selectorConditionSetOf": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#setof)",
"title": "Case sensitive",
"type": "boolean"
},
"setOf": {
"description": "Must include all of but only specified values.",
"markdownDescription": "Must include all of but only values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#setof)",
"title": "SetOf",
"type": "array"
}
},
"required": [
"setOf"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)",
"title": "Case sensitive",
"type": "boolean"
},
"convert": {
"default": false,
"description": "Convert type to string.",
"markdownDescription": "Convert type to string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)",
"title": "Type conversion",
"type": "boolean"
},
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorConditionSubset": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Case sensitive",
"type": "boolean"
},
"subset": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Subset",
"type": "array"
},
"unique": {
"default": false,
"description": "Determines if each of the field values must be unique.",
"markdownDescription": "Determines if each of the field values must be unique. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Unique",
"type": "boolean"
}
},
"required": [
"subset"
],
"type": "object"
},
"selectorConditionVersion": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"includePrerelease": {
"default": false,
"description": "Determines if pre-release versions are included. By default, pre-release versions are not included.",
"markdownDescription": "Determines if pre-release versions are included. By default, pre-release versions are not included. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#version)",
"title": "Include pre-release",
"type": "boolean"
},
"version": {
"default": "",
"description": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range.",
"markdownDescription": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#version)",
"title": "Version",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"selectorConditionWithinPath": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#withinpath)",
"title": "Case sensitive",
"type": "boolean"
},
"withinPath": {
"default": [],
"description": "The file path must exist within the required paths.",
"items": {
"type": "string"
},
"markdownDescription": "The file path must exist within the required paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#withinpath)",
"title": "Within Path",
"type": "array",
"uniqueItems": true
}
},
"required": [
"withinPath"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValue": {
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "integer"
}
]
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#allof)",
"title": "All Of",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#anyof)",
"title": "Any Of",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
}
]
},
"selectorPropertiesString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
},
{
"$ref": "#/definitions/selectorPropertyType"
},
{
"$ref": "#/definitions/selectorPropertyName"
},
{
"$ref": "#/definitions/selectorPropertySource"
}
]
},
"selectorPropertyField": {
"properties": {
"field": {
"default": ".",
"description": "The object path of a field to compare.",
"markdownDescription": "The object path of a field to compare. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
},
"selectorPropertyName": {
"properties": {
"name": {
"default": ".",
"description": "The target name of the object.",
"markdownDescription": "The target name of the object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#name)",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
]
},
"selectorPropertySource": {
"properties": {
"source": {
"description": "The source of the object currently being processed by the pipeline.",
"markdownDescription": "The source of the object currently being processed by the pipeline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#source)",
"title": "Source",
"type": "string"
}
},
"required": [
"source"
]
},
"selectorPropertyType": {
"properties": {
"type": {
"default": ".",
"description": "The target type of the object.",
"markdownDescription": "The target type of the object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#type)",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "The specification for a selector.",
"markdownDescription": "The specification for a selector. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"description": "A condition is made up of one or more expressions that will determine if an object is selected by the selector.",
"markdownDescription": "A condition is made up of one or more [expressions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/) that will determine if an object is selected by the selector. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"title": "If",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
},
"suppressionGroup-v1": {
"description": "A PSRule Suppression Group",
"markdownDescription": "A PSRule Suppression Group. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_SuppressionGroups/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule SuppressionGroup resource.",
"enum": [
"SuppressionGroup"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/suppressionGroupSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "SuppressionGroup",
"type": "object"
},
"suppressionGroupSpec": {
"additionalProperties": false,
"description": "PSRule Suppression Group specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"rule": {
"description": "This only applies to rules that match the specified rule names",
"items": {
"type": "string"
},
"title": "Rule pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/rule-v1"
},
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
},
{
"$ref": "#/definitions/suppressionGroup-v1"
}
]
} | MIT | en |
microsoft/PSRule-vscode | 128feee112c24a9768571575fc583b9362a595a5 | 2023-04-19T15:27:39 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_AKS_CLUSTER_MINIMUM_VERSION": {
"default": "1.25.4",
"description": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified.",
"markdownDescription": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-rules/#aks-minimum-kubernetes-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "AKS cluster minimum version",
"type": "string"
},
"AZURE_BICEP_CHECK_TOOL": {
"default": false,
"description": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to true.",
"markdownDescription": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to `true`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#checking-bicep-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Checking Bicep Tool",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_BICEP_MINIMUM_VERSION": {
"default": "0.4.451",
"description": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is 0.4.451.",
"markdownDescription": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is `0.4.451`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#configuring-minimum-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep Minimum Version",
"type": "string"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown.\n\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"initialSessionState": {
"default": "BuiltIn",
"description": "Determines how the initial session state for executing PowerShell code is created. The default is BuiltIn.",
"enum": [
"BuiltIn",
"Minimal"
],
"markdownDescription": "Determines how the initial session state for executing PowerShell code is created. The default is `BuiltIn`.\n- When set to `BuiltIn` all built-in cmdlets are loaded.\n- When set to `Minimal` only cmdlets for hosting PowerShell will be loaded.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninitialsessionstate)",
"title": "Initial Session State",
"type": "string"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is true.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"ruleExcluded": {
"default": "Ignore",
"description": "Determines how to handle excluded rules. Regardless of the value, excluded rules are ignored. By default, rules are excluded silently. When set to Error, an error is thrown. When set to Warn, a warning is generated. When set to Debug, a message is written to the debug log.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle excluded rules.\n\nRegardless of the value, excluded rules are ignored. By default, rules are excluded silently.\n\n- When set to `Error`, an error is thrown.\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleexecluded)",
"title": "Rule excluded",
"type": "string"
},
"ruleSuppressed": {
"default": "Warn",
"description": "Determines how to handle suppressed rules. Regardless of the value, a suppressed rule is ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces suppressedRuleWarning. You do not need to configure both options. If suppressedRuleWarning is configured, it will override ruleSuppressed with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle suppressed rules.\n\nRegardless of the value, a suppressed rule is ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `suppressedRuleWarning`. You do not need to configure both options. If `suppressedRuleWarning` is configured, it will override `ruleSuppressed` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionrulesuppressed)",
"title": "Rule suppressed",
"type": "string"
},
"suppressedRuleWarning": {
"default": true,
"deprecated": true,
"description": "This option has been deprecated and will be removed from v3 in favor of ruleSuppressed. Enable or disable warnings for suppressed rules. The default is true.",
"markdownDescription": "This option has been deprecated and will be removed from v3 in favor of `ruleSuppressed`.\n\nEnable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules | DEPRECATED",
"type": "boolean"
},
"suppressionGroupExpired": {
"default": "Warn",
"description": "Determines how to handle expired suppression groups. Regardless of the value, an expired suppression group will be ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle expired suppression groups.\n\nRegardless of the value, an expired suppression group will be ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressiongroupexpired)",
"title": "Expired suppression groups",
"type": "string"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"ignoreUnchangedPath": {
"default": false,
"description": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed.",
"markdownDescription": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreunchangedpath)",
"title": "Ignore unchanged path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jobSummaryPath": {
"description": "The path to a job summary output file.",
"markdownDescription": "The path to a job summary output file. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjobsummarypath)",
"title": "Job Summary Path",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"baseRef": {
"description": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system.",
"markdownDescription": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositorybaseref)",
"title": "Base Reference",
"type": "string"
},
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "PSRule options configuration file.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 97db94c65cd652e1af4a9e94e112670553418be7 | 2022-02-10T14:38:21 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"description": "Rules to exclude by name from the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Rules to include by name in the baseline.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"baseline": {
"$ref": "#/definitions/resourceName",
"description": "The name of a baseline to use.",
"markdownDescription": "The name of a baseline to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#rulebaseline)",
"title": "Baseline",
"type": "string"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"properties": {
"obsolete": {
"default": false,
"description": "A common annotation that flags the resource as obsolete.",
"title": "Obsolete",
"type": "boolean"
}
},
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"tags": {
"$ref": "#/definitions/resourceTags"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"resourceTags": {
"additionalProperties": {
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Tag key/ value"
}
],
"description": "Additional indexed key/ value pairs for the resource.",
"title": "Tags",
"type": "object"
},
"rule-v1": {
"description": "A rule resource.",
"markdownDescription": "A rule resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A rule resource.",
"enum": [
"Rule"
],
"markdownDescription": "A rule resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ruleMetadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/ruleSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Rule",
"type": "object"
},
"ruleMetadata": {
"description": "Additional information to identify the resource.",
"properties": {
"alias": {
"description": "Alternative names this resource is known by.",
"items": {
"$ref": "#/definitions/resourceName",
"description": "An alternative name.",
"title": "Alias",
"type": "string"
},
"title": "Aliases",
"type": "array",
"uniqueItems": true
},
"annotations": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Annotation key/ value"
}
],
"description": "Additional annotations for the resource.",
"title": "Annotations",
"type": "object"
},
"name": {
"$ref": "#/definitions/resourceName",
"description": "The name of the resource. This must be unique.",
"title": "Name",
"type": "string"
},
"ref": {
"$ref": "#/definitions/resourceName",
"description": "An optional stable opaque identifier of this resource for lookup. This must be unique if set.",
"title": "Reference"
},
"tags": {
"$ref": "#/definitions/resourceTags"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"ruleSpec": {
"additionalProperties": false,
"description": "The specification for the rule.",
"markdownDescription": "The specification for the rule. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Rules/)",
"properties": {
"condition": {
"$ref": "#/definitions/selectorExpression",
"description": "A condition is made up of one or more expressions that will determine if the rule passes or fails.",
"markdownDescription": "A condition is made up of one or more [expressions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/) that will determine if the rule passes or fails. [See help](https://microsoft.github.io/PSRule/v2/authoring/writing-rules/)",
"title": "Condition",
"type": "object"
},
"level": {
"default": "Error",
"description": "If the rule fails, how serious is the result. By default this is set to Error.",
"enum": [
"Error",
"Warning",
"Information"
],
"markdownDescription": "If the rule fails, how serious is the result. By default this is set to `Error`. [See help](https://microsoft.github.io/PSRule/v2/authoring/writing-rules/)",
"title": "Level",
"type": "string"
},
"type": {
"description": "This rule only applies to objects that match the specifies types.",
"items": {
"type": "string"
},
"title": "Type pre-condition",
"type": "array",
"uniqueItems": true
},
"with": {
"description": "This rule only applies to objects that match the specified selectors.",
"items": {
"type": "string"
},
"title": "Selector pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"condition"
],
"title": "Spec",
"type": "object"
},
"selector-v1": {
"description": "A selector resource.",
"markdownDescription": "A selector resource. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionSetOf"
},
{
"$ref": "#/definitions/selectorConditionSubset"
},
{
"$ref": "#/definitions/selectorConditionCount"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsArray"
},
{
"$ref": "#/definitions/selectorConditionIsBoolean"
},
{
"$ref": "#/definitions/selectorConditionIsDateTime"
},
{
"$ref": "#/definitions/selectorConditionIsInteger"
},
{
"$ref": "#/definitions/selectorConditionIsNumeric"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
},
{
"$ref": "#/definitions/selectorConditionHasSchema"
},
{
"$ref": "#/definitions/selectorConditionVersion"
},
{
"$ref": "#/definitions/selectorConditionHasDefault"
},
{
"$ref": "#/definitions/selectorConditionWithinPath"
},
{
"$ref": "#/definitions/selectorConditionNotWithinPath"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#contains)",
"title": "Contains"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionCount": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"count": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#count)",
"minimum": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"equals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#equals)",
"title": "Equals"
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasDefault": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasdefault)",
"title": "Case sensitive",
"type": "boolean"
},
"hasDefault": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "The field must either not exist or be set to the configured value.",
"markdownDescription": "The field must either not exist or be set to the configured value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasdefault)",
"title": "Has Default"
}
},
"required": [
"hasDefault"
],
"type": "object"
},
"selectorConditionHasSchema": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing schemas is case-sensitive.",
"markdownDescription": "Determines if comparing schemas is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Case sensitive",
"type": "boolean"
},
"hasSchema": {
"default": [],
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"items": {
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"minLength": 1,
"title": "Has schema",
"type": "string"
},
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Has schema",
"type": "array",
"uniqueItems": true
},
"ignoreScheme": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasschema)",
"title": "Ignore scheme",
"type": "boolean"
}
},
"required": [
"hasSchema"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"in": {
"description": "Must equal one of the specified values.",
"markdownDescription": "Must equal one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsArray": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isArray": {
"description": "Must be an array type.",
"markdownDescription": "Must be an array type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isarray)",
"title": "Is array",
"type": "boolean"
}
},
"required": [
"isArray"
],
"type": "object"
},
"selectorConditionIsBoolean": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to boolean.",
"markdownDescription": "Convert type to boolean. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isboolean)",
"title": "Type conversion",
"type": "boolean"
},
"isBoolean": {
"description": "Must be a boolean type.",
"markdownDescription": "Must be a boolean type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isboolean)",
"title": "Is boolean",
"type": "boolean"
}
},
"required": [
"isBoolean"
],
"type": "object"
},
"selectorConditionIsDateTime": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to datetime.",
"markdownDescription": "Convert type to datetime. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isdatetime)",
"title": "Type conversion",
"type": "boolean"
},
"isDateTime": {
"description": "Must be a datetime type.",
"markdownDescription": "Must be a datetime type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isdatetime)",
"title": "Is datetime",
"type": "boolean"
}
},
"required": [
"isDateTime"
],
"type": "object"
},
"selectorConditionIsInteger": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to integer.",
"markdownDescription": "Convert type to integer. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isinteger)",
"title": "Type conversion",
"type": "boolean"
},
"isInteger": {
"description": "Must be an integer type.",
"markdownDescription": "Must be an integer type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isinteger)",
"title": "Is integer",
"type": "boolean"
}
},
"required": [
"isInteger"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsNumeric": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"convert": {
"default": false,
"description": "Convert type to numeric.",
"markdownDescription": "Convert type to numeric. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isnumeric)",
"title": "Type conversion",
"type": "boolean"
},
"isNumeric": {
"description": "Must be a numeric type.",
"markdownDescription": "Must be a numeric type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isnumeric)",
"title": "Is numeric",
"type": "boolean"
}
},
"required": [
"isNumeric"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notEquals": {
"$ref": "#/definitions/selectorExpressionValue",
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notequals)",
"title": "Not Equals"
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the specified values.",
"markdownDescription": "Must not equal any of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionNotWithinPath": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notwithinpath)",
"title": "Case sensitive",
"type": "boolean"
},
"notWithinPath": {
"default": [],
"description": "The file path must not exist within the required paths.",
"items": {
"type": "string"
},
"markdownDescription": "The file path must not exist within the required paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#notwithinpath)",
"title": "Not Within Path",
"type": "array",
"uniqueItems": true
}
},
"required": [
"notWithinPath"
],
"type": "object"
},
"selectorConditionSetOf": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#setof)",
"title": "Case sensitive",
"type": "boolean"
},
"setOf": {
"description": "Must include all of but only specified values.",
"markdownDescription": "Must include all of but only values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#setof)",
"title": "SetOf",
"type": "array"
}
},
"required": [
"setOf"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorConditionSubset": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Case sensitive",
"type": "boolean"
},
"subset": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Subset",
"type": "array"
},
"unique": {
"default": false,
"description": "Determines if each of the field values must be unique.",
"markdownDescription": "Determines if each of the field values must be unique. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#subset)",
"title": "Unique",
"type": "boolean"
}
},
"required": [
"subset"
],
"type": "object"
},
"selectorConditionVersion": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"includePrerelease": {
"default": false,
"description": "Determines if pre-release versions are included. By default, pre-release versions are not included.",
"markdownDescription": "Determines if pre-release versions are included. By default, pre-release versions are not included. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#version)",
"title": "Include pre-release",
"type": "boolean"
},
"version": {
"default": "",
"description": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range.",
"markdownDescription": "Must be a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#version)",
"title": "Version",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"selectorConditionWithinPath": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines if comparing values is case-sensitive.",
"markdownDescription": "Determines if comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#withinpath)",
"title": "Case sensitive",
"type": "boolean"
},
"withinPath": {
"default": [],
"description": "The file path must exist within the required paths.",
"items": {
"type": "string"
},
"markdownDescription": "The file path must exist within the required paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#withinpath)",
"title": "Within Path",
"type": "array",
"uniqueItems": true
}
},
"required": [
"withinPath"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValue": {
"oneOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "integer"
}
]
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#allof)",
"title": "All Of",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#anyof)",
"title": "Any Of",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
}
]
},
"selectorPropertiesString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
},
{
"$ref": "#/definitions/selectorPropertyType"
},
{
"$ref": "#/definitions/selectorPropertyName"
},
{
"$ref": "#/definitions/selectorPropertySource"
}
]
},
"selectorPropertyField": {
"properties": {
"field": {
"default": ".",
"description": "The object path of a field to compare.",
"markdownDescription": "The object path of a field to compare. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
},
"selectorPropertyName": {
"properties": {
"name": {
"default": ".",
"description": "The target name of the object.",
"markdownDescription": "The target name of the object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#name)",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
]
},
"selectorPropertySource": {
"properties": {
"source": {
"description": "The source of the object currently being processed by the pipeline.",
"markdownDescription": "The source of the object currently being processed by the pipeline. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#source)",
"title": "Source",
"type": "string"
}
},
"required": [
"source"
]
},
"selectorPropertyType": {
"properties": {
"type": {
"default": ".",
"description": "The target type of the object.",
"markdownDescription": "The target type of the object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/#type)",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "The specification for a selector.",
"markdownDescription": "The specification for a selector. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"description": "A condition is made up of one or more expressions that will determine if an object is selected by the selector.",
"markdownDescription": "A condition is made up of one or more [expressions](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Expressions/) that will determine if an object is selected by the selector. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Selectors/)",
"title": "If",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
},
"suppressionGroup-v1": {
"description": "A PSRule Suppression Group",
"markdownDescription": "A PSRule Suppression Group. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_SuppressionGroups/)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule SuppressionGroup resource.",
"enum": [
"SuppressionGroup"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/suppressionGroupSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "SuppressionGroup",
"type": "object"
},
"suppressionGroupSpec": {
"additionalProperties": false,
"description": "PSRule Suppression Group specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"rule": {
"description": "This only applies to rules that match the specified rule names",
"items": {
"type": "string"
},
"title": "Rule pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/rule-v1"
},
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
},
{
"$ref": "#/definitions/suppressionGroup-v1"
}
]
} | MIT | en |
microsoft/PSRule-vscode | 7ddde0ed0468c171a758119c2191623ac5322564 | 2022-10-03T13:18:19 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to `Warn`, a warning is generated. When set to `Ignore`, no output will be displayed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"initialSessionState": {
"default": "BuiltIn",
"description": "Determines how the initial session state for executing PowerShell code is created. The default is BuiltIn.",
"enum": [
"BuiltIn",
"Minimal"
],
"markdownDescription": "Determines how the initial session state for executing PowerShell code is created. The default is `BuiltIn`.\n- When set to `BuiltIn` all built-in cmdlets are loaded.\n- When set to `Minimal` only cmdlets for hosting PowerShell will be loaded.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninitialsessionstate)",
"title": "Initial Session State",
"type": "string"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is true.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is true.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"ignoreUnchangedPath": {
"default": false,
"description": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed.",
"markdownDescription": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreunchangedpath)",
"title": "Ignore unchanged path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"baseRef": {
"description": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system.",
"markdownDescription": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositorybaseref)",
"title": "Base Reference",
"type": "string"
},
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | f371033a62b80beacc67690e66f65ecf9297a629 | 2022-08-27T14:18:19 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to `Warn`, a warning is generated. When set to `Ignore`, no output will be displayed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is `true`.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is `true`.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 54995eb1c6ed614a2947a3e094d85defb150bd23 | 2021-05-06T05:08:49 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"title": "Annotations",
"type": "object"
},
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"selector-v1": {
"description": "A PSRule Selector.",
"markdownDescription": "A PSRule Selector. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
}
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"equals": {
"oneOf": [
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "string"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "integer"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "boolean"
}
]
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"in": {
"description": "Must equal one the values.",
"markdownDescription": "Must equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"notEquals": {
"oneOf": [
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "string"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "integer"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "boolean"
}
]
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the values.",
"markdownDescription": "Must not equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#allof)",
"title": "AllOf",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#anyof)",
"title": "AnyOf",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"properties": {
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
}
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "PSRule selector specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
}
]
} | MIT | en |
microsoft/PSRule-vscode | 19d3bb2b5e8d09fde2bff9c3e92ad6f8cd552676 | 2023-07-28T00:18:57 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-option": {
"additionalProperties": false,
"description": "Options that configure baselines.",
"properties": {
"group": {
"additionalProperties": {
"description": "Maps a group name to a baseline.",
"title": "Group mapping",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Group}": "${2:Baseline}"
},
"label": "Baseline group"
}
],
"description": "Configure baseline group names.",
"title": "Baseline group",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_AKS_CLUSTER_MINIMUM_VERSION": {
"default": "1.25.4",
"description": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified.",
"markdownDescription": "This configuration option determines the minimum version of Kubernetes for AKS clusters and node pools. Rules that check the Kubernetes version fail when the version is older than the version specified. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-rules/#aks-minimum-kubernetes-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "AKS cluster minimum version",
"type": "string"
},
"AZURE_BICEP_CHECK_TOOL": {
"default": false,
"description": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to true.",
"markdownDescription": "This configuration option determines if the Azure Bicep CLI is checked during initialization. By default, this option is disabled. To enable, set this option to `true`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#checking-bicep-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Checking Bicep Tool",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_BICEP_MINIMUM_VERSION": {
"default": "0.4.451",
"description": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is 0.4.451.",
"markdownDescription": "This configuration option determines the minimum version of the Bicep CLI that should be used. If the minimum version is less then the expected version an error is reported. By default, this is `0.4.451`. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/setup-bicep/#configuring-minimum-version)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep Minimum Version",
"type": "string"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReference": {
"default": "Warn",
"description": "Determines how to handle when an alias to a resource is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces aliasReferenceWarning. You do not need to configure both options. If aliasReferenceWarning is configured, it will override aliasReference with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle when an alias to a resource is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `aliasReferenceWarning`. You do not need to configure both options. If `aliasReferenceWarning` is configured, it will override `aliasReference` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreference)",
"title": "Alias references",
"type": "string"
},
"aliasReferenceWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases | DEPRECATED",
"type": "boolean"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown.\n\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"hashAlgorithm": {
"default": "SHA512",
"description": "Configures the hashing algorithm used by the PSRule runtime. By default, SHA512 is used.",
"enum": [
"SHA512",
"SHA384",
"SHA256"
],
"markdownDescription": "Configures the hashing algorithm used by the PSRule runtime.\n\nBy default, `SHA512` is used.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionhashalgorithm)",
"title": "Hash Algorithm",
"type": "string"
},
"inconclusiveWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules | DEPRECATED",
"type": "boolean"
},
"initialSessionState": {
"default": "BuiltIn",
"description": "Determines how the initial session state for executing PowerShell code is created. The default is BuiltIn.",
"enum": [
"BuiltIn",
"Minimal"
],
"markdownDescription": "Determines how the initial session state for executing PowerShell code is created. The default is `BuiltIn`.\n- When set to `BuiltIn` all built-in cmdlets are loaded.\n- When set to `Minimal` only cmdlets for hosting PowerShell will be loaded.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninitialsessionstate)",
"title": "Initial Session State",
"type": "string"
},
"invariantCulture": {
"default": "Warn",
"description": "Determines how to report when an invariant culture is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces invariantCultureWarning. You do not need to configure both options. If invariantCultureWarning is configured, it will override invariantCulture with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report when an invariant culture is used. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `invariantCultureWarning`. You do not need to configure both options. If `invariantCultureWarning` is configured, it will override `invariantCulture` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculture)",
"title": "Invariant culture",
"type": "string"
},
"invariantCultureWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warning when invariant culture is used. The default is true.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture | DEPRECATED",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"deprecated": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects | DEPRECATED",
"type": "boolean"
},
"ruleExcluded": {
"default": "Ignore",
"description": "Determines how to handle excluded rules. Regardless of the value, excluded rules are ignored. By default, rules are excluded silently. When set to Error, an error is thrown. When set to Warn, a warning is generated. When set to Debug, a message is written to the debug log.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle excluded rules.\n\nRegardless of the value, excluded rules are ignored. By default, rules are excluded silently.\n\n- When set to `Error`, an error is thrown.\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleexcluded)",
"title": "Rule excluded",
"type": "string"
},
"ruleInconclusive": {
"default": "Warn",
"description": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces inconclusiveWarning. You do not need to configure both options. If inconclusiveWarning is configured, it will override ruleInconclusive with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle rules that generate inconclusive results. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `inconclusiveWarning`. You do not need to configure both options. If `inconclusiveWarning` is configured, it will override `ruleInconclusive` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionruleinconclusive)",
"title": "Inconclusive rules",
"type": "string"
},
"ruleSuppressed": {
"default": "Warn",
"description": "Determines how to handle suppressed rules. Regardless of the value, a suppressed rule is ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces suppressedRuleWarning. You do not need to configure both options. If suppressedRuleWarning is configured, it will override ruleSuppressed with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle suppressed rules.\n\nRegardless of the value, a suppressed rule is ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `suppressedRuleWarning`. You do not need to configure both options. If `suppressedRuleWarning` is configured, it will override `ruleSuppressed` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionrulesuppressed)",
"title": "Rule suppressed",
"type": "string"
},
"suppressedRuleWarning": {
"default": true,
"deprecated": true,
"description": "This option has been deprecated and will be removed from v3 in favor of ruleSuppressed. Enable or disable warnings for suppressed rules. The default is true.",
"markdownDescription": "This option has been deprecated and will be removed from v3 in favor of `ruleSuppressed`.\n\nEnable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules | DEPRECATED",
"type": "boolean"
},
"suppressionGroupExpired": {
"default": "Warn",
"description": "Determines how to handle expired suppression groups. Regardless of the value, an expired suppression group will be ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle expired suppression groups.\n\nRegardless of the value, an expired suppression group will be ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressiongroupexpired)",
"title": "Expired suppression groups",
"type": "string"
},
"unprocessedObject": {
"default": "Warn",
"description": "Determines how to report objects that are not processed by any rule. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. This option replaces notProcessedWarning. You do not need to configure both options. If notProcessedWarning is configured, it will override unprocessedObject with Warn or Ignore until removal in PSRule v3.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to report objects that are not processed by any rule. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\nThis option replaces `notProcessedWarning`. You do not need to configure both options. If `notProcessedWarning` is configured, it will override `unprocessedObject` with `Warn` or `Ignore` until removal in PSRule v3.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionunprocessedobject)",
"title": "Unprocessed object",
"type": "string"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"ignoreUnchangedPath": {
"default": false,
"description": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed.",
"markdownDescription": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreunchangedpath)",
"title": "Ignore unchanged path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"baseline": {
"$ref": "#/definitions/baseline-option",
"type": "object"
},
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jobSummaryPath": {
"description": "The path to a job summary output file.",
"markdownDescription": "The path to a job summary output file. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjobsummarypath)",
"title": "Job Summary Path",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"baseRef": {
"description": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system.",
"markdownDescription": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositorybaseref)",
"title": "Base Reference",
"type": "string"
},
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "PSRule options configuration file.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | a5d29aec5982db8426c4410519296900030032a8 | 2022-06-20T13:48:59 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is `true`.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is `true`.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"url": {
"description": "The URL to the repository.",
"markdownDescription": "The URL to the repository.",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 9be7614d4852fdb652a6314027f42175fd90f51e | 2021-10-22T02:14:39 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"title": "Annotations",
"type": "object"
},
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"title": "Tags",
"type": "object"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-v1": {
"description": "A PSRule Rule.",
"markdownDescription": "A PSRule Rule. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Rules.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Rule resource.",
"enum": [
"Rule"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/ruleSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Rule",
"type": "object"
},
"ruleSpec": {
"additionalProperties": false,
"description": "PSRule rule specification.",
"properties": {
"condition": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"type": {
"description": "This rule only applies to objects that match the specifies types.",
"items": {
"type": "string"
},
"title": "Type pre-condition",
"type": "array",
"uniqueItems": true
},
"with": {
"description": "This rule only applies to objects that match the specified selectors.",
"items": {
"type": "string"
},
"title": "Selector pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"condition"
],
"title": "Spec",
"type": "object"
},
"selector-v1": {
"description": "A PSRule Selector.",
"markdownDescription": "A PSRule Selector. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionSetOf"
},
{
"$ref": "#/definitions/selectorConditionSubset"
},
{
"$ref": "#/definitions/selectorConditionCount"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#contains)",
"title": "Contains"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionCount": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"count": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#count)",
"minimum": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"equals": {
"oneOf": [
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "string"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "integer"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "boolean"
}
]
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"in": {
"description": "Must equal one the values.",
"markdownDescription": "Must equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notEquals": {
"oneOf": [
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "string"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "integer"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "boolean"
}
]
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the values.",
"markdownDescription": "Must not equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionSetOf": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#setof)",
"title": "Case sensitive",
"type": "boolean"
},
"setOf": {
"description": "Must include all of but only specified values.",
"markdownDescription": "Must include all of but only values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#setof)",
"title": "SetOf",
"type": "array"
}
},
"required": [
"setOf"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorConditionSubset": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Case sensitive",
"type": "boolean"
},
"subset": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Subset",
"type": "array"
},
"unique": {
"default": false,
"description": "Determines each of the field values must be unique.",
"markdownDescription": "Determines each of the field values must be unique. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Unique",
"type": "boolean"
}
},
"required": [
"subset"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#allof)",
"title": "AllOf",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#anyof)",
"title": "AnyOf",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
}
]
},
"selectorPropertiesString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
},
{
"$ref": "#/definitions/selectorPropertyType"
},
{
"$ref": "#/definitions/selectorPropertyName"
}
]
},
"selectorPropertyField": {
"properties": {
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
},
"selectorPropertyName": {
"properties": {
"name": {
"default": ".",
"description": "The target name of the object.",
"markdownDescription": "The target name of the object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#name)",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
]
},
"selectorPropertyType": {
"properties": {
"type": {
"default": ".",
"description": "The target type of the object.",
"markdownDescription": "The target type of the object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#type)",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "PSRule selector specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/rule-v1"
},
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
}
]
} | MIT | en |
microsoft/PSRule-vscode | 77bc92cda8bf8a5533b9f41da448314a459e6bc2 | 2022-08-26T11:52:06 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to `Warn`, a warning is generated. When set to `Ignore`, no output will be displayed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is `true`.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is `true`.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | b4b93dd5219b0e2b52236fe1206a5d11a173048e | 2022-07-05T12:14:42 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is `true`.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is `true`.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"url": {
"description": "The URL to the repository.",
"markdownDescription": "The URL to the repository.",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 3170cc32b6d4f13811ebc19a4b5286fcd1a228eb | 2020-09-01T00:23:32 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"title": "Name separator",
"type": "string"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"description": "A set of key/ value configuration options for rules.",
"title": "Configuration values",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"title": "Warn on unprocessed objects",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"title": "Input format",
"type": "string"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"execution": {
"oneOf": [
{
"$ref": "#/definitions/execution-option"
}
],
"type": "object"
},
"input": {
"oneOf": [
{
"$ref": "#/definitions/input-option"
}
],
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"title": "Result type",
"type": "string"
},
"culture": {
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"title": "Encoding",
"type": "string"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"NUnit3",
"Csv",
"Wide"
],
"title": "Output format",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Client",
"description": "The style that results will be presented in.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions"
],
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"type": "string"
},
"description": "Specifies the required version of a module to use.",
"title": "Required modules",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Specifies rules to exclude by name.",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Optionally filter to rules by name.",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"title": "Suppress when",
"type": "string"
},
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 05ba61783516471ab18ce67a83f0a05e77a10144 | 2021-11-09T11:06:43 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"baseline": {
"$ref": "#/definitions/rule-names",
"description": "The name of a baseline to use.",
"markdownDescription": "The name of a baseline to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#rulebaseline)",
"title": "Baseline",
"type": "string"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"title": "Annotations",
"type": "object"
},
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"title": "Tags",
"type": "object"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-v1": {
"description": "A PSRule Rule.",
"markdownDescription": "A PSRule Rule. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Rules.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Rule resource.",
"enum": [
"Rule"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/ruleSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Rule",
"type": "object"
},
"ruleSpec": {
"additionalProperties": false,
"description": "PSRule rule specification.",
"properties": {
"condition": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"type": {
"description": "This rule only applies to objects that match the specifies types.",
"items": {
"type": "string"
},
"title": "Type pre-condition",
"type": "array",
"uniqueItems": true
},
"with": {
"description": "This rule only applies to objects that match the specified selectors.",
"items": {
"type": "string"
},
"title": "Selector pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"condition"
],
"title": "Spec",
"type": "object"
},
"selector-v1": {
"description": "A PSRule Selector.",
"markdownDescription": "A PSRule Selector. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionSetOf"
},
{
"$ref": "#/definitions/selectorConditionSubset"
},
{
"$ref": "#/definitions/selectorConditionCount"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#contains)",
"title": "Contains"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionCount": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"count": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#count)",
"minimum": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"equals": {
"oneOf": [
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "string"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "integer"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "boolean"
}
]
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"in": {
"description": "Must equal one the values.",
"markdownDescription": "Must equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notEquals": {
"oneOf": [
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "string"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "integer"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "boolean"
}
]
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the values.",
"markdownDescription": "Must not equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionSetOf": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#setof)",
"title": "Case sensitive",
"type": "boolean"
},
"setOf": {
"description": "Must include all of but only specified values.",
"markdownDescription": "Must include all of but only values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#setof)",
"title": "SetOf",
"type": "array"
}
},
"required": [
"setOf"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorConditionSubset": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Case sensitive",
"type": "boolean"
},
"subset": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Subset",
"type": "array"
},
"unique": {
"default": false,
"description": "Determines each of the field values must be unique.",
"markdownDescription": "Determines each of the field values must be unique. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Unique",
"type": "boolean"
}
},
"required": [
"subset"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#allof)",
"title": "AllOf",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#anyof)",
"title": "AnyOf",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
}
]
},
"selectorPropertiesString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
},
{
"$ref": "#/definitions/selectorPropertyType"
},
{
"$ref": "#/definitions/selectorPropertyName"
}
]
},
"selectorPropertyField": {
"properties": {
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
},
"selectorPropertyName": {
"properties": {
"name": {
"default": ".",
"description": "The target name of the object.",
"markdownDescription": "The target name of the object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#name)",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
]
},
"selectorPropertyType": {
"properties": {
"type": {
"default": ".",
"description": "The target type of the object.",
"markdownDescription": "The target type of the object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#type)",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "PSRule selector specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/rule-v1"
},
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
}
]
} | MIT | en |
microsoft/PSRule-vscode | ef84c902318b7c02ec765b7435069d5583a32aa2 | 2022-01-31T22:13:20 | schemas/PSRule-resources.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A schema for PSRule resources.",
"items": {
"anyOf": [
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/rule-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/baseline-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/moduleConfig-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/selector-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/suppressionGroup-v1"
}
]
},
"title": "PSRule resources",
"type": "array"
} | MIT | en |
microsoft/PSRule-vscode | 57f74fd3382387e34ca58ebb04db67c104de5f8a | 2022-03-02T07:16:03 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is `true`.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is `true`.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, and RunInfo.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, and `RunInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"Default"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"url": {
"description": "The URL to the repository.",
"markdownDescription": "The URL to the repository.",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "${2:'>=1.0.0'}"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 657528aac7b6174bb56415e1e0b3fc3c3092f388 | 2021-03-18T13:57:13 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect rule execution.",
"properties": {
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
}
},
"title": "Execution options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputformat)",
"title": "Input format",
"type": "string"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Ignores input files that match the path spec.",
"items": {
"type": "string"
},
"markdownDescription": "Ignores input files that match the path spec. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"oneOf": [
{
"$ref": "#/definitions/execution-option"
}
],
"type": "object"
},
"input": {
"oneOf": [
{
"$ref": "#/definitions/input-option"
}
],
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputas)",
"title": "Result type",
"type": "string"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputencoding)",
"title": "Encoding",
"type": "string"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputformat)",
"title": "Output format",
"type": "string"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputpath)",
"title": "Output path",
"type": "string"
},
"style": {
"default": "Client",
"description": "The style that results will be presented in. The default is Client.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions"
],
"markdownDescription": "The style that results will be presented in. The default is `Client`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"requires": {
"additionalProperties": {
"type": "string"
},
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#requires)",
"title": "Required modules",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Specifies rules to exclude by name.",
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Optionally filter to rules by name.",
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
microsoft/PSRule-vscode | 128feee112c24a9768571575fc583b9362a595a5 | 2023-04-19T15:27:39 | schemas/PSRule-resources.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"description": "A meta schema for defining PSRule resources in a JSON document.",
"items": {
"anyOf": [
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/rule-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/baseline-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/moduleConfig-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/selector-v1"
},
{
"$ref": "https://raw.githubusercontent.com/microsoft/PSRule/main/schemas/PSRule-language.schema.json#/definitions/suppressionGroup-v1"
}
]
},
"title": "PSRule resources",
"type": "array"
} | MIT | en |
microsoft/PSRule-vscode | 12ff821c2d539aef0a060bc58bd2b6ecacc9836f | 2020-10-20T09:24:49 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Baseline",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"moduleConfig": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
}
},
"title": "ModuleConfig",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"title": "Annotations",
"type": "object"
},
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML language files.",
"oneOf": [
{
"$ref": "#/definitions/baseline"
},
{
"$ref": "#/definitions/moduleConfig"
}
],
"title": "PSRule language"
} | MIT | en |
microsoft/PSRule-vscode | 7bb4e8aed9b1ee593199cc83515934f3d86b9022 | 2021-08-08T15:09:40 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"title": "Annotations",
"type": "object"
},
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"title": "Tags",
"type": "object"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-v1": {
"description": "A PSRule Rule.",
"markdownDescription": "A PSRule Rule. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Rules.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Rule resource.",
"enum": [
"Rule"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/ruleSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Rule",
"type": "object"
},
"ruleSpec": {
"additionalProperties": false,
"description": "PSRule rule specification.",
"properties": {
"condition": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"type": {
"description": "This rule only applies to objects that match the specifies types.",
"items": {
"type": "string"
},
"title": "Type pre-condition",
"type": "array",
"uniqueItems": true
},
"with": {
"description": "This rule only applies to objects that match the specified selectors.",
"items": {
"type": "string"
},
"title": "Selector pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"condition"
],
"title": "Spec",
"type": "object"
},
"selector-v1": {
"description": "A PSRule Selector.",
"markdownDescription": "A PSRule Selector. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#contains)",
"title": "Contains"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"equals": {
"oneOf": [
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "string"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "integer"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "boolean"
}
]
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"in": {
"description": "Must equal one the values.",
"markdownDescription": "Must equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"notEquals": {
"oneOf": [
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "string"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "integer"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "boolean"
}
]
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the values.",
"markdownDescription": "Must not equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#allof)",
"title": "AllOf",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#anyof)",
"title": "AnyOf",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"properties": {
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
}
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "PSRule selector specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/rule-v1"
},
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
}
]
} | MIT | en |
microsoft/PSRule-vscode | 7821dcf5aa8cd4549f2464e441ed3d917fd835ee | 2021-12-23T00:24:59 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"baseline": {
"$ref": "#/definitions/rule-names",
"description": "The name of a baseline to use.",
"markdownDescription": "The name of a baseline to use. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#rulebaseline)",
"title": "Baseline",
"type": "string"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"title": "Annotations",
"type": "object"
},
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"title": "Tags",
"type": "object"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"rule-v1": {
"description": "A PSRule Rule.",
"markdownDescription": "A PSRule Rule. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Rules.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Rule resource.",
"enum": [
"Rule"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/ruleSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Rule",
"type": "object"
},
"ruleSpec": {
"additionalProperties": false,
"description": "PSRule rule specification.",
"properties": {
"condition": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
},
"type": {
"description": "This rule only applies to objects that match the specifies types.",
"items": {
"type": "string"
},
"title": "Type pre-condition",
"type": "array",
"uniqueItems": true
},
"with": {
"description": "This rule only applies to objects that match the specified selectors.",
"items": {
"type": "string"
},
"title": "Selector pre-condition",
"type": "array",
"uniqueItems": true
}
},
"required": [
"condition"
],
"title": "Spec",
"type": "object"
},
"selector-v1": {
"description": "A PSRule Selector.",
"markdownDescription": "A PSRule Selector. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionSetOf"
},
{
"$ref": "#/definitions/selectorConditionSubset"
},
{
"$ref": "#/definitions/selectorConditionCount"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
},
{
"$ref": "#/definitions/selectorConditionHasSchema"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#contains)",
"title": "Contains"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionCount": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"count": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#count)",
"minimum": 0,
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"equals": {
"oneOf": [
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "string"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "integer"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "boolean"
}
]
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasSchema": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines comparing schemas is case-sensitive.",
"markdownDescription": "Determines comparing schemas is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"title": "Case sensitive",
"type": "boolean"
},
"hasSchema": {
"default": [],
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"items": {
"description": "Must use one of the specified schemas of the value of $schema. If an empty array is specified any non-empty $schema can be specified.",
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"minLength": 1,
"title": "Has schema",
"type": "string"
},
"markdownDescription": "Must use one of the specified schemas of the value of `$schema`. If an empty array is specified any non-empty `$schema` can be specified [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"title": "Has schema",
"type": "array",
"uniqueItems": true
},
"ignoreScheme": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasschema)",
"title": "Ignore scheme",
"type": "boolean"
}
},
"required": [
"hasSchema"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"in": {
"description": "Must equal one the values.",
"markdownDescription": "Must equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notEquals": {
"oneOf": [
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "string"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "integer"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "boolean"
}
]
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the values.",
"markdownDescription": "Must not equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionSetOf": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#setof)",
"title": "Case sensitive",
"type": "boolean"
},
"setOf": {
"description": "Must include all of but only specified values.",
"markdownDescription": "Must include all of but only values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#setof)",
"title": "SetOf",
"type": "array"
}
},
"required": [
"setOf"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertiesString"
}
],
"properties": {
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorConditionSubset": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"caseSensitive": {
"default": false,
"description": "Determines comparing values is case-sensitive.",
"markdownDescription": "Determines comparing values is case-sensitive. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Case sensitive",
"type": "boolean"
},
"subset": {
"description": "Must include all of the specified values.",
"markdownDescription": "Must include all of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Subset",
"type": "array"
},
"unique": {
"default": false,
"description": "Determines each of the field values must be unique.",
"markdownDescription": "Determines each of the field values must be unique. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#subset)",
"title": "Unique",
"type": "boolean"
}
},
"required": [
"subset"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#allof)",
"title": "AllOf",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#anyof)",
"title": "AnyOf",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
}
]
},
"selectorPropertiesString": {
"oneOf": [
{
"$ref": "#/definitions/selectorPropertyField"
},
{
"$ref": "#/definitions/selectorPropertyType"
},
{
"$ref": "#/definitions/selectorPropertyName"
}
]
},
"selectorPropertyField": {
"properties": {
"field": {
"default": ".",
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
},
"selectorPropertyName": {
"properties": {
"name": {
"default": ".",
"description": "The target name of the object.",
"markdownDescription": "The target name of the object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#name)",
"title": "Name",
"type": "string"
}
},
"required": [
"name"
]
},
"selectorPropertyType": {
"properties": {
"type": {
"default": ".",
"description": "The target type of the object.",
"markdownDescription": "The target type of the object. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#type)",
"title": "Type",
"type": "string"
}
},
"required": [
"type"
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "PSRule selector specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/rule-v1"
},
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
}
]
} | MIT | en |
microsoft/PSRule-vscode | c1579dbbdebe97621b62475ec3630b85cb1a9d8c | 2019-12-05T00:37:33 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline": {
"additionalProperties": false,
"properties": {
"kind": {
"description": "The type of PSRule resource.",
"enum": [
"Baseline"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baseline-spec",
"type": "object"
}
},
"required": [
"kind",
"metadata",
"spec"
],
"type": "object"
},
"baseline-spec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"properties": {
"binding": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"title": "Ignore case",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"description": "Baseline specific configuration options.",
"title": "Configuration",
"type": "object",
"uniqueItems": true
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Baseline",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML language files.",
"oneOf": [
{
"$ref": "#/definitions/baseline"
}
],
"title": "PSRule language"
} | MIT | en |
microsoft/PSRule-vscode | 33ba3c920662b89202b77c513d9c48233ee7f0d2 | 2021-07-19T00:14:38 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline-v1": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"markdownDescription": "A PSRule Baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"markdownDescription": "A PSRule Baseline resource. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"markdownDescription": "A specification for a baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Baseline.html)",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"markdownDescription": "Rules to exclude by name from the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleexclude)",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"markdownDescription": "Rules to include by name in the baseline. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruleinclude)",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#configuration)",
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"markdownDescription": "An ordered list of conventions to include. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#conventioninclude)",
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"moduleConfig-v1": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/binding-option"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"convention": {
"$ref": "#/definitions/convention-option"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Options.html#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
}
},
"title": "Spec",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"annotations": {
"title": "Annotations",
"type": "object"
},
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"selector-v1": {
"description": "A PSRule Selector.",
"markdownDescription": "A PSRule Selector. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html)",
"properties": {
"apiVersion": {
"description": "The API Version for the PSRule resources.",
"enum": [
"github.com/microsoft/PSRule/v1"
],
"title": "API Version",
"type": "string"
},
"kind": {
"description": "A PSRule Selector resource.",
"enum": [
"Selector"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/selectorSpec",
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Selector",
"type": "object"
},
"selectorCondition": {
"oneOf": [
{
"$ref": "#/definitions/selectorConditionExists"
},
{
"$ref": "#/definitions/selectorConditionEquals"
},
{
"$ref": "#/definitions/selectorConditionNotEquals"
},
{
"$ref": "#/definitions/selectorConditionHasValue"
},
{
"$ref": "#/definitions/selectorConditionMatch"
},
{
"$ref": "#/definitions/selectorConditionNotMatch"
},
{
"$ref": "#/definitions/selectorConditionIn"
},
{
"$ref": "#/definitions/selectorConditionNotIn"
},
{
"$ref": "#/definitions/selectorConditionLess"
},
{
"$ref": "#/definitions/selectorConditionLessOrEquals"
},
{
"$ref": "#/definitions/selectorConditionGreater"
},
{
"$ref": "#/definitions/selectorConditionGreaterOrEquals"
},
{
"$ref": "#/definitions/selectorConditionStartsWith"
},
{
"$ref": "#/definitions/selectorConditionEndsWith"
},
{
"$ref": "#/definitions/selectorConditionContains"
},
{
"$ref": "#/definitions/selectorConditionIsString"
},
{
"$ref": "#/definitions/selectorConditionIsLower"
},
{
"$ref": "#/definitions/selectorConditionIsUpper"
}
],
"type": "object"
},
"selectorConditionContains": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"contains": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must contain one of the specified values.",
"markdownDescription": "Must contain one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#contains)",
"title": "Contains"
}
},
"required": [
"contains"
],
"type": "object"
},
"selectorConditionEndsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"endsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must end with one of the specified values.",
"markdownDescription": "Must end with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#endswith)",
"title": "Ends with"
}
},
"required": [
"endsWith"
],
"type": "object"
},
"selectorConditionEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"equals": {
"oneOf": [
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "string"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "integer"
},
{
"description": "Must have the specified value.",
"markdownDescription": "Must have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#equals)",
"title": "Equals",
"type": "boolean"
}
]
}
},
"required": [
"equals"
],
"type": "object"
},
"selectorConditionExists": {
"properties": {
"exists": {
"description": "Must have the named field.",
"markdownDescription": "Must have the named field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#exists)",
"title": "Exists",
"type": "boolean"
},
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"exists",
"field"
],
"type": "object"
},
"selectorConditionGreater": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"greater": {
"description": "Must be greater then the specified value.",
"markdownDescription": "Must be greater then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greater)",
"title": "Greater",
"type": "integer"
}
},
"required": [
"greater"
],
"type": "object"
},
"selectorConditionGreaterOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"greaterOrEquals": {
"description": "Must be greater or equal to the specified value.",
"markdownDescription": "Must be greater or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#greaterorequals)",
"title": "Greater or Equal to",
"type": "integer"
}
},
"required": [
"greaterOrEquals"
],
"type": "object"
},
"selectorConditionHasValue": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"hasValue": {
"description": "Must have a non-empty value.",
"markdownDescription": "Must have a non-empty value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#hasvalue)",
"title": "Has Value",
"type": "boolean"
}
},
"required": [
"hasValue"
],
"type": "object"
},
"selectorConditionIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"in": {
"description": "Must equal one the values.",
"markdownDescription": "Must equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#in)",
"title": "In",
"type": "array"
}
},
"required": [
"in"
],
"type": "object"
},
"selectorConditionIsLower": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"isLower": {
"description": "Must be a lowercase string.",
"markdownDescription": "Must be a lowercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#islower)",
"title": "Is Lowercase",
"type": "boolean"
}
},
"required": [
"isLower"
],
"type": "object"
},
"selectorConditionIsString": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"isString": {
"description": "Must be a string type.",
"markdownDescription": "Must be a string type. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isstring)",
"title": "Is string",
"type": "boolean"
}
},
"required": [
"isString"
],
"type": "object"
},
"selectorConditionIsUpper": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"isUpper": {
"description": "Must be an uppercase string.",
"markdownDescription": "Must be an uppercase string. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#isupper)",
"title": "Is Uppercase",
"type": "boolean"
}
},
"required": [
"isUpper"
],
"type": "object"
},
"selectorConditionLess": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"less": {
"description": "Must be less then the specified value.",
"markdownDescription": "Must be less then the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#less)",
"title": "Less",
"type": "integer"
}
},
"required": [
"less"
],
"type": "object"
},
"selectorConditionLessOrEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"lessOrEquals": {
"description": "Must be less or equal to the specified value.",
"markdownDescription": "Must be less or equal to the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#lessorequals)",
"title": "Less or Equal to",
"type": "integer"
}
},
"required": [
"lessOrEquals"
],
"type": "object"
},
"selectorConditionMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"match": {
"description": "Must match the regular expression.",
"markdownDescription": "Must match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#match)",
"title": "Match",
"type": "string"
}
},
"required": [
"match"
],
"type": "object"
},
"selectorConditionNotEquals": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"notEquals": {
"oneOf": [
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "string"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "integer"
},
{
"description": "Must not have the specified value.",
"markdownDescription": "Must not have the specified value. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notequals)",
"title": "Not Equals",
"type": "boolean"
}
]
}
},
"required": [
"notEquals"
],
"type": "object"
},
"selectorConditionNotIn": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"notIn": {
"description": "Must not equal any of the values.",
"markdownDescription": "Must not equal one the values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notin)",
"title": "Not In",
"type": "array"
}
},
"required": [
"notIn"
],
"type": "object"
},
"selectorConditionNotMatch": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"notMatch": {
"description": "Must not match the regular expression.",
"markdownDescription": "Must not match the regular expression. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#notmatch)",
"title": "Not Match",
"type": "string"
}
},
"required": [
"notMatch"
],
"type": "object"
},
"selectorConditionStartsWith": {
"oneOf": [
{
"$ref": "#/definitions/selectorProperties"
}
],
"properties": {
"startsWith": {
"$ref": "#/definitions/selectorExpressionValueMultiString",
"description": "Must start with one of the specified values.",
"markdownDescription": "Must start with one of the specified values. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#startswith)",
"title": "Starts with"
}
},
"required": [
"startsWith"
],
"type": "object"
},
"selectorExpression": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperator"
},
{
"$ref": "#/definitions/selectorCondition"
}
],
"type": "object"
},
"selectorExpressionValueMultiString": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"selectorOperator": {
"oneOf": [
{
"$ref": "#/definitions/selectorOperatorAllOf"
},
{
"$ref": "#/definitions/selectorOperatorAnyOf"
},
{
"$ref": "#/definitions/selectorOperatorNot"
}
],
"type": "object"
},
"selectorOperatorAllOf": {
"additionalProperties": false,
"properties": {
"allOf": {
"description": "All of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#allof)",
"title": "AllOf",
"type": "array"
}
},
"required": [
"allOf"
],
"type": "object"
},
"selectorOperatorAnyOf": {
"additionalProperties": false,
"properties": {
"anyOf": {
"description": "One of the expressions must be true.",
"items": {
"$ref": "#/definitions/selectorExpression"
},
"markdownDescription": "All of the expressions must be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#anyof)",
"title": "AnyOf",
"type": "array"
}
},
"required": [
"anyOf"
],
"type": "object"
},
"selectorOperatorNot": {
"properties": {
"not": {
"$ref": "#/definitions/selectorExpression",
"description": "The nested expression must not be true.",
"markdownDescription": "The nested expression must not be true. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#not)",
"title": "Not",
"type": "object"
}
},
"required": [
"not"
],
"type": "object"
},
"selectorProperties": {
"oneOf": [
{
"properties": {
"field": {
"description": "The path of the field.",
"markdownDescription": "The path of the field. [See help](https://microsoft.github.io/PSRule/concepts/PSRule/en-US/about_PSRule_Selectors.html#field)",
"title": "Field",
"type": "string"
}
},
"required": [
"field"
]
}
]
},
"selectorSpec": {
"additionalProperties": false,
"description": "PSRule selector specification.",
"properties": {
"if": {
"$ref": "#/definitions/selectorExpression",
"type": "object"
}
},
"required": [
"if"
],
"title": "Spec",
"type": "object"
}
},
"oneOf": [
{
"$ref": "#/definitions/baseline-v1"
},
{
"$ref": "#/definitions/moduleConfig-v1"
},
{
"$ref": "#/definitions/selector-v1"
}
]
} | MIT | en |
microsoft/PSRule-vscode | 2fa68b64975db1bfbe626463e96634b983baa361 | 2020-05-04T12:17:26 | schemas/PSRule-language.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"baseline": {
"additionalProperties": false,
"description": "A PSRule Baseline.",
"properties": {
"kind": {
"description": "A PSRule Baseline resource.",
"enum": [
"Baseline"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/baselineSpec",
"type": "object"
}
},
"required": [
"kind",
"metadata",
"spec"
],
"title": "Baseline",
"type": "object"
},
"baselineSpec": {
"additionalProperties": false,
"description": "A specification for a baseline.",
"properties": {
"binding": {
"$ref": "#/definitions/bindingOption"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"rule": {
"additionalProperties": false,
"description": "A filter for included or excluded rules.",
"properties": {
"exclude": {
"$ref": "#/definitions/rule-names",
"description": "Rules to exclude by name from the baseline.",
"title": "Exclude rules",
"type": "array"
},
"include": {
"$ref": "#/definitions/rule-names",
"description": "Rules to include by name in the baseline.",
"title": "Include rules",
"type": "array"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"title": "Tags",
"type": "object"
}
},
"title": "Rule",
"type": "object"
}
},
"title": "Baseline",
"type": "object"
},
"bindingOption": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"title": "Name separator",
"type": "string"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"description": "A set of key/ value configuration options for rules.",
"title": "Configuration values",
"type": "object"
},
"moduleConfig": {
"additionalProperties": false,
"description": "A PSRule ModuleConfig.",
"properties": {
"kind": {
"description": "A PSRule ModuleConfig resource.",
"enum": [
"ModuleConfig"
],
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/resource-metadata",
"type": "object"
},
"spec": {
"$ref": "#/definitions/moduleConfigSpec",
"type": "object"
}
},
"required": [
"kind",
"metadata",
"spec"
],
"title": "ModuleConfig",
"type": "object"
},
"moduleConfigSpec": {
"additionalProperties": false,
"description": "A specification for a ModuleConfig.",
"properties": {
"binding": {
"$ref": "#/definitions/bindingOption"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"output": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"culture": {
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"title": "Culture",
"type": "array",
"uniqueItems": true
}
},
"title": "Output options",
"type": "object"
}
},
"title": "ModuleConfig",
"type": "object"
},
"resource-metadata": {
"description": "Additional information to identify the resource.",
"properties": {
"name": {
"description": "The name of the resource. This must be unique.",
"minLength": 3,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "Metadata",
"type": "object"
},
"rule-name": {
"minLength": 3,
"type": "string"
},
"rule-names": {
"items": {
"$ref": "#/definitions/rule-name",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML language files.",
"oneOf": [
{
"$ref": "#/definitions/baseline"
},
{
"$ref": "#/definitions/moduleConfig"
}
],
"title": "PSRule language"
} | MIT | en |
microsoft/PSRule-vscode | 8a950fa1ba965c5faf7c1cf518decd03d1ae2a66 | 2022-11-19T05:32:15 | schemas/PSRule-options.schema.json | 44 | 2024-05-29T18:00:00.274793Z | {
"$ref": "#/definitions/options",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"binding-option": {
"additionalProperties": false,
"description": "Configure property/ object binding options.",
"properties": {
"field": {
"additionalProperties": {
"description": "A custom field to bind.",
"items": {
"type": "string"
},
"markdownDescription": "Custom field to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"type": "array",
"uniqueItems": true
},
"description": "Custom fields to bind.",
"markdownDescription": "Custom fields to bind. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingfield)",
"title": "Field",
"type": "object"
},
"ignoreCase": {
"default": true,
"description": "Determines if custom binding uses ignores case when matching properties. The default is true.",
"markdownDescription": "Determines if custom binding uses ignores case when matching properties. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingignorecase)",
"title": "Ignore case",
"type": "boolean"
},
"nameSeparator": {
"default": "/",
"description": "Configures the separator to use for building a qualified name. The default is '/'.",
"markdownDescription": "Configures the separator to use for building a qualified name. The default is `/`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingnameseparator)",
"title": "Name separator",
"type": "string"
},
"preferTargetInfo": {
"default": false,
"description": "Determines if binding prefers target info provided by the object over custom configuration. The default is false.",
"markdownDescription": "Determines if binding prefers target info provided by the object over custom configuration. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingprefertargetinfo)",
"title": "Prefer target info",
"type": "boolean"
},
"targetName": {
"description": "Specifies one or more property names to bind TargetName to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetName to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargetname)",
"title": "Bind TargetName",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Specifies one or more property names to bind TargetType to.",
"items": {
"type": "string"
},
"markdownDescription": "Specifies one or more property names to bind TargetType to. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingtargettype)",
"title": "Bind TargetType",
"type": "array",
"uniqueItems": true
},
"useQualifiedName": {
"default": false,
"description": "Determines if a qualified TargetName is used. The default is false.",
"markdownDescription": "Determines if a qualified TargetName is used. The default is `false`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#bindingusequalifiedname)",
"title": "Use qualified name",
"type": "boolean"
}
},
"title": "Object binding",
"type": "object"
},
"configuration": {
"additionalProperties": true,
"defaultSnippets": [
{
"body": {
"${1:Key}": "${2:Value}"
},
"label": "Custom configuration value"
}
],
"description": "A set of key/ value configuration options for rules.",
"markdownDescription": "A set of key/ value configuration options for rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#configuration)",
"properties": {
"AZURE_BICEP_FILE_EXPANSION": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_BICEP_FILE_EXPANSION_TIMEOUT": {
"default": 5,
"description": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds.",
"markdownDescription": "This configuration option determines the maximum time to spend building a single Bicep source file. The timeout is configured in seconds. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepcompilationtimeout)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"maximum": 120,
"minimum": 1,
"title": "Bicep compilation timeout",
"type": "integer"
},
"AZURE_DEPLOYMENT": {
"additionalProperties": false,
"description": "This configuration option sets the deployment object use by the deployment() function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the deployment object use by the `deployment()` function. Configure this option to change the details of the deployment when exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentproperties)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "ps-rule-test-deployment",
"type": "string"
}
},
"title": "Deployment properties",
"type": "object"
},
"AZURE_MANAGEMENT_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the management group object used by the managementGroup() function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the management group object used by the `managementGroup()` function. Configure this option to change the management group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentmanagementgroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"name": {
"default": "psrule-test",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"displayName": {
"default": "PSRule Test Management Group",
"type": "string"
}
},
"type": "object"
}
},
"title": "Deployment management group",
"type": "object"
},
"AZURE_PARAMETER_DEFAULTS": {
"description": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used.",
"markdownDescription": "This configuration option allows a fallback value to be configured for required parameters. When a parameter value is not provided and a default is not set, the fallback value will be used. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#requiredparameterdefaults)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Required parameter defaults",
"type": "object"
},
"AZURE_PARAMETER_FILE_EXPANSION": {
"default": false,
"description": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules.",
"markdownDescription": "Determines if Azure template parameter files will automatically be expanded. By default, parameter files will not be automatically expanded. When enabled, PSRule will discover and expand JSON parameter files for Azure templates or Bicep modules. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#parameterfileexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Parameter file expansion",
"type": "boolean"
},
"AZURE_PARAMETER_FILE_METADATA_LINK": {
"default": false,
"description": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded.",
"markdownDescription": "This configuration option determines if Azure Bicep source files will automatically be expanded. By default, Bicep files will not be automatically expanded. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#bicepsourceexpansion)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"title": "Bicep source expansion",
"type": "boolean"
},
"AZURE_RESOURCE_GROUP": {
"additionalProperties": false,
"description": "This configuration option sets the resource group object used by the resourceGroup() function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the resource group object used by the `resourceGroup()` function. Configure this option to change the resource group object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentresourcegroup)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"location": {
"default": "eastus",
"type": "string"
},
"name": {
"default": "ps-rule-test-rg",
"type": "string"
},
"properties": {
"additionalProperties": false,
"properties": {
"provisioningState": {
"default": "Succeeded",
"type": "string"
}
},
"type": "object"
},
"tags": {
"default": {},
"type": "object"
}
},
"title": "Deployment resource group",
"type": "object"
},
"AZURE_SUBSCRIPTION": {
"additionalProperties": false,
"description": "This configuration option sets the subscription object used by the subscription() function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the subscription object used by the `subscription()` function. Configure this option to change the subscription object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymentsubscription)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"displayName": {
"default": "PSRule Test Subscription",
"type": "string"
},
"state": {
"default": "NotDefined",
"type": "string"
},
"subscriptionId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment subscription",
"type": "object"
},
"AZURE_TENANT": {
"additionalProperties": false,
"description": "This configuration option sets the tenant object used by the tenant() function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default.",
"markdownDescription": "This configuration option sets the tenant object used by the `tenant()` function. Configure this option to change the tenant object when using exporting templates for analysis. Provided properties will override the default. [See help](https://azure.github.io/PSRule.Rules.Azure/setup/configuring-expansion/#deploymenttenant)\r\rApplies to: [PSRule for Azure](https://aka.ms/ps-rule-azure)",
"properties": {
"countryCode": {
"default": "US",
"type": "string"
},
"displayName": {
"default": "PSRule",
"type": "string"
},
"tenantId": {
"default": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"type": "string"
}
},
"title": "Deployment tenant",
"type": "object"
}
},
"title": "Configuration values",
"type": "object"
},
"convention-option": {
"additionalProperties": false,
"description": "Options that configure conventions.",
"properties": {
"include": {
"description": "An ordered list of conventions to include.",
"items": {
"type": "string"
},
"title": "Include conventions",
"type": "array",
"uniqueItems": true
}
},
"title": "Convention options",
"type": "object"
},
"execution-option": {
"additionalProperties": false,
"description": "Options that affect execution.",
"markdownDescription": "Options that affect execution. [See help](https://aka.ms/ps-rule/options)",
"properties": {
"aliasReferenceWarning": {
"default": true,
"description": "Enable or disable warnings when an alias to a resource is used. The default is true.",
"markdownDescription": "Enable or disable warnings when an alias to a resource is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionaliasreferencewarning)",
"title": "Warn on resource aliases",
"type": "boolean"
},
"duplicateResourceId": {
"default": "Error",
"description": "Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle duplicate resources identifiers during execution.\n\nRegardless of the value, only the first resource will be used. By defaut, an error is thrown.\n\n- When set to `Warn`, a warning is generated.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionduplicateresourceid)",
"title": "Duplicate resource identifiers",
"type": "string"
},
"inconclusiveWarning": {
"default": true,
"description": "Enable or disable warnings for inconclusive rules. The default is true.",
"markdownDescription": "Enable or disable warnings for inconclusive rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninconclusivewarning)",
"title": "Warn on inconclusive rules",
"type": "boolean"
},
"initialSessionState": {
"default": "BuiltIn",
"description": "Determines how the initial session state for executing PowerShell code is created. The default is BuiltIn.",
"enum": [
"BuiltIn",
"Minimal"
],
"markdownDescription": "Determines how the initial session state for executing PowerShell code is created. The default is `BuiltIn`.\n- When set to `BuiltIn` all built-in cmdlets are loaded.\n- When set to `Minimal` only cmdlets for hosting PowerShell will be loaded.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninitialsessionstate)",
"title": "Initial Session State",
"type": "string"
},
"invariantCultureWarning": {
"default": true,
"description": "Enable or disable warning when invariant culture is used. The default is true.",
"markdownDescription": "Enable or disable warning when invariant culture is used. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executioninvariantculturewarning)",
"title": "Warn on invariant culture",
"type": "boolean"
},
"languageMode": {
"default": "FullLanguage",
"description": "The PowerShell language mode to use for rule execution. The default is FullLanguage.",
"enum": [
"FullLanguage",
"ConstrainedLanguage"
],
"markdownDescription": "The PowerShell language mode to use for rule execution. The default is `FullLanguage`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode)",
"title": "Language mode",
"type": "string"
},
"notProcessedWarning": {
"default": true,
"description": "Enable or disable warnings for objects that are not processed by any rule. The default is true.",
"markdownDescription": "Enable or disable warnings for objects that are not processed by any rule. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionnotprocessedwarning)",
"title": "Warn on unprocessed objects",
"type": "boolean"
},
"suppressedRuleWarning": {
"default": true,
"description": "Enable or disable warnings for suppressed rules. The default is true.",
"markdownDescription": "Enable or disable warnings for suppressed rules. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressedrulewarning)",
"title": "Warn on suppressed rules",
"type": "boolean"
},
"suppressionGroupExpired": {
"default": "Warn",
"description": "Determines how to handle expired suppression groups. Regardless of the value, an expired suppression group will be ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed.",
"enum": [
"Ignore",
"Warn",
"Error",
"Debug"
],
"markdownDescription": "Determines how to handle expired suppression groups.\n\nRegardless of the value, an expired suppression group will be ignored. By default, a warning is generated.\n\n- When set to `Error`, an error is thrown.\n- When set to `Debug`, a message is written to the debug log.\n- When set to `Ignore`, no output will be displayed.\n\n[See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#executionsuppressiongroupexpired)",
"title": "Expired suppression groups",
"type": "string"
}
},
"title": "Execution options",
"type": "object"
},
"include-option": {
"additionalProperties": false,
"description": "Options that affect source locations imported for execution.",
"properties": {
"module": {
"description": "Automatically include rules and resources from the specified modules.",
"items": {
"description": "Automatically include rules and resources from the specified modules.",
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified modules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includemodule)",
"title": "Include module",
"type": "array",
"uniqueItems": true
},
"path": {
"description": "Automatically include rules and resources from the specified paths.",
"items": {
"description": "Automatically include rules and resources from the specified paths.",
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "string"
},
"markdownDescription": "Automatically include rules and resources from the specified paths. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#includepath)",
"title": "Include path",
"type": "array",
"uniqueItems": true
}
},
"title": "Include options",
"type": "object"
},
"input-option": {
"additionalProperties": false,
"description": "Options that affect how input types are processed.",
"markdownDescription": "Options that affect how input types are processed.",
"properties": {
"format": {
"default": "Detect",
"description": "The input string format. The default is Detect, which will try to detect the format when the -InputPath parameter is used.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"PowerShellData",
"File",
"Detect"
],
"markdownDescription": "The input string format. The default is `Detect`, which will try to detect the format when the `-InputPath` parameter is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputformat)",
"title": "Input format",
"type": "string"
},
"ignoreGitPath": {
"default": true,
"description": "Determine if files within the .git path are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if files within the `.git` path are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoregitpath)",
"title": "Ignore .git path",
"type": "boolean"
},
"ignoreObjectSource": {
"default": false,
"description": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of pathIgnore, ignoreGitPath, and ignoreRepositoryCommon options.",
"markdownDescription": "Determines if objects are ignore based on their file source path. When set, objects from the pipeline or read from files will be exclude based on their source path and the configuration of `pathIgnore`, `ignoreGitPath`, and `ignoreRepositoryCommon` options. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreobjectsource)",
"title": "Ignore object source",
"type": "boolean"
},
"ignoreRepositoryCommon": {
"default": true,
"description": "Determine if common repository files are ignored when the -InputPath parameter is used. This is enabled by default.",
"markdownDescription": "Determine if common repository files are ignored when the `-InputPath` parameter is used. This is enabled by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignorerepositorycommon)",
"title": "Ignore common files",
"type": "boolean"
},
"ignoreUnchangedPath": {
"default": false,
"description": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed.",
"markdownDescription": "Determine if unchanged files are ignored. By default, PSRule will process all files within an input path. For large repositories, this can result in a large number of files being processed. Additionally, for a pull request you may only be interested in files that have changed. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputignoreunchangedpath)",
"title": "Ignore unchanged path",
"type": "boolean"
},
"objectPath": {
"description": "The object path to a property to use instead of the pipeline object.",
"markdownDescription": "The object path to a property to use instead of the pipeline object. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputobjectpath)",
"title": "Object path",
"type": "string"
},
"pathIgnore": {
"description": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use ! at the start of the entry. Wildcards are supported.",
"items": {
"type": "string"
},
"markdownDescription": "Exclude input files that match the path spec. To exclude a file specify the path prefix or file name. To re-include previously excluded paths use `!` at the start of the entry. Wildcards are supported. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputpathignore)",
"title": "Path ignore",
"type": "array",
"uniqueItems": true
},
"targetType": {
"description": "Only process objects that match one of the included types.",
"items": {
"type": "string"
},
"markdownDescription": "Only process objects that match one of the included types. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#inputtargettype)",
"title": "Target type",
"type": "array",
"uniqueItems": true
}
},
"title": "Input options",
"type": "object"
},
"logging-option": {
"additionalProperties": false,
"description": "Options for configuring information logging.",
"properties": {
"limitDebug": {
"description": "Limits debug messages to a list of named debug scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits debug messages to a list of named debug scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitdebug)",
"title": "Scopes for debug messages",
"type": "array",
"uniqueItems": true
},
"limitVerbose": {
"description": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default.",
"items": {
"type": "string"
},
"markdownDescription": "Limits verbose messages to a list of named verbose scopes. No scopes are set by default. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#logginglimitverbose)",
"title": "Scopes for verbose messages",
"type": "array",
"uniqueItems": true
},
"ruleFail": {
"default": "None",
"description": "Log fail outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log fail outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulefail)",
"title": "Report fail to stream",
"type": "string"
},
"rulePass": {
"default": "None",
"description": "Log pass outcomes for each rule to a specific informational stream. The default is None.",
"enum": [
"None",
"Error",
"Warning",
"Information"
],
"markdownDescription": "Log pass outcomes for each rule to a specific informational stream. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#loggingrulepass)",
"title": "Report pass to stream",
"type": "string"
}
},
"title": "Logging options",
"type": "object"
},
"options": {
"additionalProperties": false,
"properties": {
"binding": {
"oneOf": [
{
"$ref": "#/definitions/binding-option"
}
],
"type": "object"
},
"configuration": {
"oneOf": [
{
"$ref": "#/definitions/configuration"
}
],
"type": "object"
},
"convention": {
"$ref": "#/definitions/convention-option",
"type": "object"
},
"execution": {
"$ref": "#/definitions/execution-option",
"type": "object"
},
"include": {
"$ref": "#/definitions/include-option",
"type": "object"
},
"input": {
"$ref": "#/definitions/input-option",
"type": "object"
},
"logging": {
"oneOf": [
{
"$ref": "#/definitions/logging-option"
}
],
"type": "object"
},
"output": {
"$ref": "#/definitions/output-option",
"type": "object"
},
"repository": {
"$ref": "#/definitions/repository-option",
"type": "object"
},
"requires": {
"$ref": "#/definitions/requires",
"type": "object"
},
"rule": {
"oneOf": [
{
"$ref": "#/definitions/rule-option"
}
],
"type": "object"
},
"suppression": {
"oneOf": [
{
"$ref": "#/definitions/suppression-option"
}
],
"type": "object"
}
}
},
"output-option": {
"additionalProperties": false,
"description": "Options that affect how output is generated.",
"properties": {
"as": {
"default": "Detail",
"description": "Determine if detailed or summary results are generated. The default is Detail.",
"enum": [
"Detail",
"Summary"
],
"markdownDescription": "Determine if detailed or summary results are generated. The default is `Detail`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas)",
"title": "Result type",
"type": "string"
},
"banner": {
"default": "Default",
"description": "The information displayed for Assert-PSRule banner. The default is Default which includes Title, Source, SupportLinks, and RepositoryInfo.",
"markdownDescription": "The information displayed for Assert-PSRule banner. The default is `Default` which includes `Title`, `Source`, `SupportLinks`, and `RepositoryInfo`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner)",
"oneOf": [
{
"enum": [
"None",
"Title",
"Source",
"SupportLinks",
"RepositoryInfo",
"Default",
"Minimal"
],
"type": "string"
},
{
"type": "integer"
}
],
"title": "Banner format"
},
"culture": {
"defaultSnippets": [
{
"bodyText": [
"en-AU"
],
"label": "en-AU"
},
{
"bodyText": [
"en-US"
],
"label": "en-US"
},
{
"bodyText": [
"en-GB"
],
"label": "en-GB"
}
],
"description": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used.",
"items": {
"description": "A culture for generating output.",
"minLength": 2,
"type": "string"
},
"markdownDescription": "One or more cultures to use for generating output. When multiple cultures are specified, the first matching culture will be used. By default, the current PowerShell culture is used. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputculture)",
"title": "Culture",
"type": "array",
"uniqueItems": true
},
"encoding": {
"default": "Default",
"description": "The encoding to use when writing results to file. The default is Default, UTF-8 without BOM.",
"enum": [
"Default",
"UTF8",
"UTF7",
"Unicode",
"UTF32",
"ASCII"
],
"markdownDescription": "The encoding to use when writing results to file. The default is `Default`, UTF-8 without BOM. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding)",
"title": "Encoding",
"type": "string"
},
"footer": {
"default": "Default",
"description": "The information displayed for Assert-PSRule footer. The default is Default which includes RuleCount, RunInfo, and OutputFile.",
"markdownDescription": "The information displayed for Assert-PSRule footer. The default is `Default` which includes `RuleCount`, `RunInfo`, and `OutputFile`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputfooter)",
"oneOf": [
{
"enum": [
"None",
"RuleCount",
"RunInfo",
"OutputFile",
"Default"
],
"type": "string"
},
{
"minimum": 0,
"type": "integer"
}
],
"title": "Footer format"
},
"format": {
"default": "None",
"description": "The output format to use when returning results. The default is None.",
"enum": [
"None",
"Yaml",
"Json",
"Markdown",
"NUnit3",
"Csv",
"Wide",
"Sarif"
],
"markdownDescription": "The output format to use when returning results. The default is `None`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputformat)",
"title": "Output format",
"type": "string"
},
"jobSummaryPath": {
"description": "The path to a job summary output file.",
"markdownDescription": "The path to a job summary output file. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjobsummarypath)",
"title": "Job Summary Path",
"type": "string"
},
"jsonIndent": {
"default": 0,
"description": "The indentation level for JSON output. The default is 0.",
"markdownDescription": "The indentation level for JSON output. The default is `0`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputjsonindent)",
"maximum": 4,
"minimum": 0,
"title": "Output Json Indent",
"type": "integer"
},
"outcome": {
"default": "Processed",
"description": "The outcome of rule results to return. The default is Processed.",
"enum": [
"None",
"Fail",
"Pass",
"Error",
"Processed",
"All"
],
"markdownDescription": "The outcome of rule results to return. The default is `Processed`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputoutcome)",
"title": "Output outcome",
"type": "string"
},
"path": {
"description": "The file path location to save results.",
"markdownDescription": "The file path location to save results. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath)",
"title": "Output path",
"type": "string"
},
"sarifProblemsOnly": {
"default": true,
"description": "Determines if SARIF output only includes rules with fail or error outcomes. The default is true.",
"markdownDescription": "Determines if SARIF output only includes rules with fail or error outcomes. The default is `true`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputsarifproblemsonly)",
"title": "SARIF Problems Only",
"type": "boolean"
},
"style": {
"default": "Detect",
"description": "The style that results will be presented in. The default is Detect.",
"enum": [
"Client",
"Plain",
"AzurePipelines",
"GitHubActions",
"VisualStudioCode",
"Detect"
],
"markdownDescription": "The style that results will be presented in. The default is `Detect`. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputstyle)",
"title": "Output Style",
"type": "string"
}
},
"title": "Output options",
"type": "object"
},
"repository-option": {
"additionalProperties": false,
"description": "Configures repository options.",
"markdownDescription": "Configures repository options.",
"properties": {
"baseRef": {
"description": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system.",
"markdownDescription": "Sets the repository base ref used for comparisons of changed files. By default, the base ref is detected from environment vairables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositorybaseref)",
"title": "Base Reference",
"type": "string"
},
"url": {
"description": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system.",
"markdownDescription": "Sets the repository URL reported in output. By default, the repository URL is detected from environment variables set by the build system. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#repositoryurl)",
"title": "Repository URL",
"type": "string"
}
},
"title": "Repository",
"type": "object"
},
"requires": {
"additionalProperties": {
"description": "Specifies a module to constrain to a specific version.",
"markdownDescription": "Specifies a module to constrain to a specific version. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"pattern": "^(@pre |@prerelease )?(((?:^|~|\\>=|\\>|=|\\<=|\\<)?v?(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?)(?:\\s|\\s?\\|\\|\\s?)?){1,}$",
"title": "Version constraint",
"type": "string"
},
"defaultSnippets": [
{
"body": {
"${1:Module}": "'>=${2:1.0.0}'"
},
"label": "Version constraint"
}
],
"description": "Specifies the required version of a module to use.",
"markdownDescription": "Specifies the required version of a module to use. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#requires)",
"title": "Required modules",
"type": "object"
},
"resourceName": {
"minLength": 3,
"type": "string"
},
"rule-option": {
"additionalProperties": false,
"description": "Options that include/ exclude and configure rules.",
"properties": {
"exclude": {
"description": "Specifies rules to exclude by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Specifies rules to exclude by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleexclude)",
"title": "Exclude rules",
"type": "array",
"uniqueItems": true
},
"include": {
"description": "Optionally filter to rules by name.",
"items": {
"$ref": "#/definitions/resourceName",
"type": "string"
},
"markdownDescription": "Optionally filter to rules by name. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleinclude)",
"title": "Include rules",
"type": "array",
"uniqueItems": true
},
"includeLocal": {
"default": false,
"description": "Automatically include all local rules in the search path unless they have been explicitly excluded.",
"markdownDescription": "Automatically include all local rules in the search path unless they have been explicitly excluded. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruleincludelocal)",
"title": "Include local",
"type": "boolean"
},
"tag": {
"additionalProperties": {
"oneOf": [
{
"description": "A required tag.",
"type": "string"
},
{
"description": "A required tag.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"description": "Require rules to have the following tags.",
"markdownDescription": "Require rules to have the following tags. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#ruletag)",
"title": "Tags",
"type": "object"
}
},
"title": "Baseline options",
"type": "object"
},
"suppression-option": {
"additionalProperties": {
"oneOf": [
{
"description": "The name of the rule to suppress.",
"items": {
"description": "Suppress the rule on TargetNames to suppress.",
"markdownDescription": "Suppress the rule on TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "string"
},
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppressed rule",
"type": "array",
"uniqueItems": true
},
{
"additionalProperties": false,
"description": "The name of the rule to suppress.",
"markdownDescription": "The name of the rule to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"properties": {
"targetName": {
"description": "One or more TargetNames to suppress.",
"items": {
"type": "string"
},
"markdownDescription": "One or more TargetNames to suppress. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress when",
"type": "array",
"uniqueItems": true
}
},
"required": [
"targetName"
],
"title": "Suppressed rule",
"type": "object"
}
]
},
"description": "Specifies suppression rules.",
"markdownDescription": "Specifies suppression rules. [See help](https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#suppression)",
"title": "Suppress rules",
"type": "object",
"uniqueItems": true
}
},
"description": "A schema for PSRule YAML options files.",
"title": "PSRule options"
} | MIT | en |
corda/corda-runtime-os | f2458e1c1f273035ea699321d652830d7b479e1d | 2024-01-23T13:18:26 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$comment": "TODO-[CORE-19372]: make 'databases' and 'stateManager' required",
"$defs": {
"basicAuthConfig": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "Configuration for which username and password may be provided inline or via a secret",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"connectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetimeSeconds\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "Maximum pool size",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum pool size (defaults to pool's max size value when null)"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "Connection pool configuration for JDBC connections",
"type": "object"
},
"databaseEngine": {
"default": "postgresql",
"enum": [
"postgresql"
],
"title": "The Database Engine Type",
"type": "string"
},
"databaseTemplate": {
"additionalProperties": false,
"default": {},
"properties": {
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "The database host"
},
"name": {
"minLength": 1,
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "The database port",
"type": "integer"
},
"type": {
"$ref": "#/$defs/databaseEngine"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"name",
"username",
"password"
],
"title": "Connection settings for databases used by the Platform",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"connectionPool": {},
"database": "state-manager",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"connectionPool": {
"$ref": "#/$defs/connectionPool",
"default": {},
"title": "JDBC connection pool configuration for State Manager DB"
},
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"postgresql.example.com"
],
"title": "the State Manager database host"
},
"name": {
"default": "state-manager",
"examples": [
"state-manager"
],
"minLength": 1,
"title": "the name of the State Manager database",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the State Manager database port",
"type": "integer"
},
"type": {
"$ref": "#/$defs/databaseEngine"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "State Manager database configuration",
"type": "object"
},
"type": {
"default": "DATABASE",
"enum": [
"DATABASE"
],
"examples": [
"DATABASE"
],
"title": "The type of State Manager",
"type": "string"
}
},
"title": "State Manager configuration",
"type": "object"
},
"stateManagerRuntimeConnectionSettings": {
"additionalProperties": false,
"default": {},
"if": {
"properties": {
"type": {
"const": "Database"
}
}
},
"properties": {
"connectionPool": {},
"password": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage used by the State Manager instance",
"type": "string"
},
"username": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
}
},
"required": [
"type"
],
"then": {
"properties": {
"connectionPool": {
"$ref": "#/$defs/connectionPool",
"default": {},
"title": "JDBC connection pool configuration for the State Manager instance"
}
}
},
"title": "Runtime connection settings for a given State Manager instance and Persistent Storage",
"type": "object"
},
"stateTypePersistentStorageMapping": {
"additionalProperties": false,
"default": {},
"properties": {
"partition": {
"default": "default",
"minLength": 1,
"title": "The name of the internal representation (schema, region, partition, namespace, etc.) within the persistent storage that will be used to manage states",
"type": "string"
},
"storageId": {
"default": "default",
"minLength": 1,
"title": "The id of the persistent storage, defined elsewhere, that will be used to manage states",
"type": "string"
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage used by the State Manager instance",
"type": "string"
}
},
"required": [
"type",
"storageId",
"partition"
],
"title": "Association between a State Type managed by the State Manager and a defined Persistent Storage",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"$comment": "TODO-[CORE-19372]: should we replace 'cluster', 'crypto' and 'rbac' by the new 'databases' section instead?.",
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"databases": {
"items": {
"$ref": "#/$defs/databaseTemplate"
},
"title": "Administrator credentials per database, used to configure users/roles and grant required runtime permissions",
"type": "array"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the entire 'stateManager' section",
"crypto": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
}
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"databases": {
"$comment": "At least one database with name 'default' must be defined",
"contains": {
"properties": {
"name": {
"const": "default",
"type": "string"
}
},
"type": "object"
},
"items": {
"allOf": [
{
"$ref": "#/$defs/databaseTemplate"
}
],
"required": [
"host",
"port",
"type"
],
"type": "object"
},
"minItems": 1,
"title": "List of databases used by the platform",
"type": "array"
},
"db": {
"$comment": "TODO-[CORE-19372]: should we replace this by the new 'databases' instead?.",
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"$ref": "#/$defs/databaseEngine",
"title": "the cluster database type"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"dropLabels": {
"examples": [
[
"virtualnode_destination"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for labels that Prometheus should drop across all metrics; if empty, all labels are kept",
"type": "array"
},
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"keepNames": {
"examples": [
[
"jvm_.*"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for the names of metrics that Prometheus should keep; if empty, all metrics are kept",
"type": "array"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"default": {},
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowCheckpoint' states",
"type": "object"
},
"flowMapping": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowMapping' states",
"type": "object"
},
"keyRotation": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'keyRotation' states",
"type": "object"
},
"p2pSession": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'peerToPeerSession' states",
"type": "object"
},
"tokenPoolCache": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'tokenPoolCache' states",
"type": "object"
}
},
"required": [
"flowCheckpoint",
"flowMapping",
"keyRotation",
"p2pSession",
"tokenPoolCache"
],
"title": "Persistent Storage configuration for each State Type managed by the State Manager within the Platform",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'keyRotation' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"keyRotation": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"keyRotation"
],
"type": "object"
}
]
}
},
"required": [
"stateManager",
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'flowCheckpoint' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowCheckpoint"
],
"type": "object"
}
]
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'flowMapping' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"flowMapping": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowMapping"
],
"type": "object"
}
]
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'p2pSession' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"p2pSession": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"p2pSession"
],
"type": "object"
}
]
}
},
"required": [
"stateManager"
]
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'keyRotation' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"keyRotation": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"keyRotation"
],
"type": "object"
}
]
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service",
"stateManager"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"sharding": {
"additionalProperties": false,
"default": {
"enabled": false,
"image": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"replicaCount": 2
},
"properties": {
"enabled": {
"default": "false",
"title": "enable sharding of requests",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "registry.k8s.io",
"examples": [
"registry.k8s.io"
],
"minLength": 1,
"title": "sharding image registry",
"type": "string"
},
"repository": {
"examples": [
"ingress-nginx/controller"
],
"minLength": 1,
"title": "sharding image repository",
"type": "string"
},
"tag": {
"default": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98",
"examples": [
"v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
],
"minLength": 1,
"title": "sharding image tag",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "sharding image configuration",
"type": "object"
},
"replicaCount": {
"default": 2,
"examples": [
2
],
"title": "sharding replica count",
"type": "integer"
}
},
"required": [
"enabled",
"image",
"replicaCount"
],
"title": "token selection sharding configuration",
"type": "object"
},
"stateManager": {
"$comment": "TODO-[CORE-19372]: remove the condition and leave 'tokenPoolCache' only.",
"oneOf": [
{
"$ref": "#/$defs/stateManager"
},
{
"additionalProperties": false,
"properties": {
"tokenPoolCache": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"tokenPoolCache"
],
"type": "object"
}
]
}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 31f03d729211f4e54185eeebc7a66fe66328cc82 | 2024-01-26T15:51:48 | applications/workers/worker-common/src/main/resources/net/corda/applications/workers/workercommon/boot/corda.boot.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"databaseConfig": {
"properties": {
"jdbc": {
"additionalProperties": false,
"description": "The JDBC database configuration",
"properties": {
"directory": {
"description": "The JDBC driver directory",
"type": [
"string",
"null"
]
},
"driver": {
"description": "The JDBC driver class",
"type": [
"string",
"null"
]
},
"url": {
"description": "The JDBC URL to of the database",
"type": [
"string",
"null"
]
}
}
},
"pass": {
"description": "Password to connect to this database",
"type": [
"string",
"null"
]
},
"pool": {
"additionalProperties": false,
"description": "Connection pool properties",
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"description": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"keepAliveTimeSeconds": {
"default": 0,
"description": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"maxLifetimeSeconds": {
"default": 1800,
"description": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"minimum": 1,
"type": [
"integer",
"null"
]
},
"maxSize": {
"default": 5,
"description": "Maximum connection pool size",
"type": [
"integer",
"null"
]
},
"minSize": {
"default": 0,
"description": "Minimum connection pool size",
"type": [
"integer",
"null"
]
},
"validationTimeoutSeconds": {
"default": 5,
"description": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"minimum": 1,
"type": [
"integer",
"null"
]
}
}
},
"user": {
"description": "Username to connect to this database",
"type": [
"string",
"null"
]
}
},
"required": [
"jdbc",
"user",
"pass"
]
},
"stateTypeConfig": {
"$comment": "Polymorphic state manager storage connection configuration. The valid section depends on which state manager implementation is in use.",
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "DATABASE"
}
}
},
"then": {
"properties": {
"database": {
"$ref": "#/$defs/databaseConfig",
"description": "Config for a state type backed by database"
}
},
"required": [
"database"
]
}
}
],
"properties": {
"additionalProperties": false,
"type": {
"description": "The type of state manager implementation.",
"enum": [
"DATABASE"
]
}
},
"required": [
"type"
]
}
},
"$id": "https://corda.r3.com/net/corda/schema/configuration/boot/1.0/corda.boot.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "Configuration schema for the boot config. This configures stores the values the worker is bootstrapped with.",
"properties": {
"crypto": {
"description": "Configuration options specific to crypto worker.",
"properties": {},
"type": "object"
},
"db": {
"additionalProperties": false,
"description": "Configuration options related to database.",
"properties": {
"bus": {
"description": "Details about the bus type if it is backed by a DB",
"properties": {
"busType": {
"description": "The type of DB message bus. e.g INMEMORY or DATABASE",
"type": [
"string",
"null"
]
}
}
},
"database": {
"description": "Database params",
"properties": {
"jdbc": {
"description": "The JDBC database info",
"properties": {
"directory": {
"description": "The JDBC directory",
"type": [
"string",
"null"
]
},
"url": {
"description": "The JDBC URL used by the db worker",
"type": [
"string",
"null"
]
},
"url_messagebus": {
"description": "The JDBC URL for the message bus if the bus is backed by a DB",
"type": [
"string",
"null"
]
}
}
},
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string",
"null"
]
},
"user": {
"description": "Cluster admin username to connect to the database with.",
"type": [
"string",
"null"
]
}
}
}
}
},
"dir": {
"additionalProperties": false,
"description": "Configuration for file system directories.",
"properties": {
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string"
]
},
"tmp": {
"description": "Tmp directory",
"type": [
"string"
]
},
"workspace": {
"description": "Local workspace directory",
"type": [
"string"
]
}
}
},
"instanceId": {
"description": "Unique ID for this worker.",
"minimum": 0,
"type": "integer"
},
"kafka": {
"description": "Configuration options specific to kafka backend.",
"properties": {
"common": {
"description": "Kafka properties that are common between consumers and producers, e.g. connection details, security settings.",
"type": "object"
}
}
},
"maxAllowedMessageSize": {
"default": 972800,
"description": "Maximum allowed size, in bytes, for publishing Messages. This is required for initial push of config to Kafka.",
"maximum": 8388608,
"minimum": 512000,
"type": "integer"
},
"rest": {
"description": "Configuration options related to REST worker.",
"properties": {
"tls": {
"description": "Transport Layer Security (TLS) params",
"properties": {
"ca": {
"description": "Certification Authority Certificate chain in PEM format",
"properties": {
"crt": {
"properties": {
"path": {
"description": "File path to the Certification Authority Certificate chain in PEM format",
"type": [
"string",
"null"
]
}
}
}
}
},
"crt": {
"description": "Certificate to use in PEM format",
"properties": {
"path": {
"description": "File path to the certificate in PEM format",
"type": [
"string",
"null"
]
}
}
},
"key": {
"description": "Private key to use in PEM format",
"properties": {
"path": {
"description": "File path to the private key in PEM format",
"type": [
"string",
"null"
]
}
}
},
"keystore": {
"description": "Keystore info",
"properties": {
"password": {
"description": "The password for the Keystore",
"type": [
"string",
"null"
]
},
"path": {
"description": "Path to a Keystore file",
"type": [
"string",
"null"
]
}
}
}
}
}
}
},
"stateManager": {
"additionalProperties": {
"$ref": "#/$defs/stateTypeConfig",
"type": "object"
},
"description": "Map of configuration options for state types backed by a storage medium."
},
"topicPrefix": {
"default": "",
"description": "Topic prefix to apply when connecting to topics.",
"type": "string"
},
"worker": {
"additionalProperties": false,
"description": "HTTP connection information for the Corda workers",
"properties": {
"endpoints": {
"additionalProperties": true,
"description": "Internal endpoints for Corda worker load balancers",
"properties": {
"crypto": {
"description": "Endpoint for the CryptoWorker load balancer",
"type": [
"string",
"null"
]
},
"persistence": {
"description": "Endpoint for the PersistenceWorker load balancer",
"type": [
"string",
"null"
]
},
"uniqueness": {
"description": "Endpoint for the UniquenessWorker load balancer",
"type": [
"string",
"null"
]
},
"verification": {
"description": "Endpoint for the VerificationWorker load balancer",
"type": [
"string",
"null"
]
}
}
}
}
}
},
"title": "Corda Boot Configuration Schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 059336494a9f7efbd0a3893e4fa63d5671ea7b98 | 2022-09-19T08:56:40 | libs/configuration/configuration-validation/src/test/resources/schema/valid/test-reference.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/schema/valid/test-reference.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"default": {},
"properties": {
"bar": {
"default": false,
"type": "boolean"
},
"foo": {
"default": [
1,
2,
3
],
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"foo"
],
"title": "Test reference schema object",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 01a9b434b69ff38a14c0efcd11a9adac110271d0 | 2023-07-25T12:26:32 | libs/configuration/configuration-validation/src/test/resources/schema/bad-reference/bad-reference.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/schema/bad-reference/bad-reference.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"testInteger": {
"default": 7,
"maximum": 500,
"minimum": 0,
"type": "integer"
},
"testReference": {
"$ref": "https://corda.r3.com/schema/bad-reference/test-reference.json"
},
"testString": {
"type": "string"
}
},
"title": "Validation test schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | d1f91af462f94855a4649fcbfc95ddc5df6d4d5c | 2024-02-12T15:27:51 | applications/workers/worker-common/src/main/resources/net/corda/applications/workers/workercommon/boot/corda.boot.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/configuration/boot/1.0/corda.boot.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "Configuration schema for the boot config. This configures stores the values the worker is bootstrapped with.",
"properties": {
"crypto": {
"description": "Configuration options specific to crypto worker.",
"properties": {},
"type": "object"
},
"db": {
"additionalProperties": false,
"description": "Configuration options related to database.",
"properties": {
"bus": {
"description": "Details about the bus type if it is backed by a DB",
"properties": {
"busType": {
"description": "The type of DB message bus. e.g INMEMORY or DATABASE",
"type": [
"string",
"null"
]
}
}
},
"database": {
"description": "Database params",
"properties": {
"jdbc": {
"description": "The JDBC database info",
"properties": {
"directory": {
"description": "The JDBC directory",
"type": [
"string",
"null"
]
},
"url": {
"description": "The JDBC URL used by the db worker",
"type": [
"string",
"null"
]
},
"url_messagebus": {
"description": "The JDBC URL for the message bus if the bus is backed by a DB",
"type": [
"string",
"null"
]
}
}
},
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string",
"null"
]
},
"user": {
"description": "Cluster admin username to connect to the database with.",
"type": [
"string",
"null"
]
}
}
}
}
},
"dir": {
"additionalProperties": false,
"description": "Configuration for file system directories.",
"properties": {
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string"
]
},
"tmp": {
"description": "Tmp directory",
"type": [
"string"
]
},
"workspace": {
"description": "Local workspace directory",
"type": [
"string"
]
}
}
},
"instanceId": {
"description": "Unique ID for this worker.",
"minimum": 0,
"type": "integer"
},
"kafka": {
"description": "Configuration options specific to kafka backend.",
"properties": {
"common": {
"description": "Kafka properties that are common between consumers and producers, e.g. connection details, security settings.",
"type": "object"
}
}
},
"maxAllowedMessageSize": {
"default": 972800,
"description": "Maximum allowed size, in bytes, for publishing Messages. This is required for initial push of config to Kafka.",
"maximum": 8388608,
"minimum": 512000,
"type": "integer"
},
"rest": {
"description": "Configuration options related to REST worker.",
"properties": {
"tls": {
"description": "Transport Layer Security (TLS) params",
"properties": {
"ca": {
"description": "Certification Authority Certificate chain in PEM format",
"properties": {
"crt": {
"properties": {
"path": {
"description": "File path to the Certification Authority Certificate chain in PEM format",
"type": [
"string",
"null"
]
}
}
}
}
},
"crt": {
"description": "Certificate to use in PEM format",
"properties": {
"path": {
"description": "File path to the certificate in PEM format",
"type": [
"string",
"null"
]
}
}
},
"key": {
"description": "Private key to use in PEM format",
"properties": {
"path": {
"description": "File path to the private key in PEM format",
"type": [
"string",
"null"
]
}
}
},
"keystore": {
"description": "Keystore info",
"properties": {
"password": {
"description": "The password for the Keystore",
"type": [
"string",
"null"
]
},
"path": {
"description": "Path to a Keystore file",
"type": [
"string",
"null"
]
}
}
}
}
}
}
},
"stateManager": {
"$ref": "https://corda.r3.com/net/corda/schema/configuration/stateManager/1.0/corda.stateManager.json",
"description": "State Manager configuration."
},
"topicPrefix": {
"default": "",
"description": "Topic prefix to apply when connecting to topics.",
"type": "string"
},
"worker": {
"additionalProperties": false,
"description": "HTTP connection information for the Corda workers",
"properties": {
"endpoints": {
"additionalProperties": true,
"description": "Internal endpoints for Corda worker load balancers",
"properties": {
"crypto": {
"description": "Endpoint for the CryptoWorker load balancer",
"type": [
"string",
"null"
]
},
"persistence": {
"description": "Endpoint for the PersistenceWorker load balancer",
"type": [
"string",
"null"
]
},
"uniqueness": {
"description": "Endpoint for the UniquenessWorker load balancer",
"type": [
"string",
"null"
]
},
"verification": {
"description": "Endpoint for the VerificationWorker load balancer",
"type": [
"string",
"null"
]
}
}
},
"mediatorReplicas": {
"additionalProperties": false,
"description": "Number of replicas for the mediator",
"properties": {
"flowMapperSessionIn": {
"default": 1,
"description": "Number of mediator replicas that consume the flow mapper session in messages.",
"maximum": 64,
"minimum": 1,
"type": "integer"
},
"flowMapperSessionOut": {
"default": 1,
"description": "Number of mediator replicas that consume the flow mapper session out messages.",
"maximum": 64,
"minimum": 1,
"type": "integer"
},
"flowSession": {
"default": 1,
"description": "Number of mediator replicas that consume the flow session messages.",
"maximum": 64,
"minimum": 1,
"type": "integer"
}
}
}
}
}
},
"title": "Corda Boot Configuration Schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | a0c9d5d88daceb254007af0eecefffa9061adec0 | 2022-08-10T09:55:45 | libs/packaging/packaging-verify/src/main/resources/corda-cpk-2.0.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/packaging/cpk/2.0/corda.cpk.dependencies.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Schema for CPK dependencies",
"properties": {
"dependencies": {
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"verifyFileHash"
]
},
{
"required": [
"verifySameSignerAsMe"
]
}
],
"properties": {
"name": {
"description": "CPK name",
"type": "string"
},
"verifyFileHash": {
"description": "File hash of third party CPK",
"properties": {
"algorithm": {
"description": "Hash algorithm name",
"type": "string"
},
"fileHash": {
"description": "Base64 encoded hash",
"type": "string"
}
},
"required": [
"algorithm",
"fileHash"
],
"type": "object"
},
"verifySameSignerAsMe": {
"description": "Used for dependencies built by the same developer",
"enum": [
true
]
},
"version": {
"description": "CPK version",
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"type": "array"
},
"formatVersion": {
"type": "string"
}
},
"required": [
"formatVersion",
"dependencies"
],
"title": "Corda CPK 2.0 Schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 549847b3cbe89cda625fa27972c48e45c0c5f8ab | 2023-10-24T12:35:24 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"basicAuthConfig": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "Configuration for which username and password may be provided inline or via a secret",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"stateManager": {
"additionalProperties": true,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"connectionPool": {},
"database": "state-manager",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"connectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"postgresql.example.com"
],
"title": "the State Manager database host"
},
"name": {
"default": "state-manager",
"examples": [
"state-manager"
],
"minLength": 1,
"title": "the name of the State Manager database",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the State Manager database port",
"type": "integer"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the State Manager database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "State Manager database configuration",
"type": "object"
},
"type": {
"default": "DATABASE",
"enum": [
"DATABASE"
],
"examples": [
"DATABASE"
],
"title": "The type of State Manager",
"type": "string"
}
},
"title": "State Manager configuration",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"flow": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/basicAuthConfig"
}
]
}
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"keepNames": {
"default": [],
"examples": [
[
"jvm_.*"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for the names of metrics that Prometheus should keep; if empty, all metrics are kept",
"type": "array"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$ref": "#/$defs/stateManager"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"$ref": "#/$defs/stateManager"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"sharding": {
"additionalProperties": false,
"default": {
"enabled": false,
"image": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"replicaCount": 2
},
"properties": {
"enabled": {
"default": "false",
"title": "enable sharding of requests",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "registry.k8s.io",
"examples": [
"registry.k8s.io"
],
"minLength": 1,
"title": "sharding image registry",
"type": "string"
},
"repository": {
"examples": [
"ingress-nginx/controller"
],
"minLength": 1,
"title": "sharding image repository",
"type": "string"
},
"tag": {
"default": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98",
"examples": [
"v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
],
"minLength": 1,
"title": "sharding image tag",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "sharding image configuration",
"type": "object"
},
"replicaCount": {
"default": 2,
"examples": [
2
],
"title": "sharding replica count",
"type": "integer"
}
},
"required": [
"enabled",
"image",
"replicaCount"
],
"title": "token selection sharding configuration",
"type": "object"
}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | f9a197a8394a892de594b1a5fc89f3deaeb2d40f | 2023-10-10T08:42:02 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "STATE_MANAGER",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "STATE_MANAGER",
"examples": [
"STATE_MANAGER"
],
"minLength": 1,
"title": "the schema in which the State Manager entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "State Manager db configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManagerDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "Flow worker JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Flow worker minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "Flow worker JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation",
"stateManagerDbConnectionPool"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 942b836f9f646940fff20dc783ba1437244fe319 | 2023-09-13T11:27:58 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cleanup": false,
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cleanup": {
"default": false,
"examples": [
false,
true
],
"title": "specifies whether existing topics with the given prefix should be deleted before trying to create new ones (deletes all existing topics if no prefix is given)",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"cleanup",
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 2953dc7a20da996521ed515342f4b2966ae9c622 | 2023-09-21T13:30:52 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "STATE_MANAGER",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "STATE_MANAGER",
"examples": [
"STATE_MANAGER"
],
"minLength": 1,
"title": "the schema in which the State Manager entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "State Manager db configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cleanup": false,
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cleanup": {
"default": false,
"examples": [
false,
true
],
"title": "specifies whether existing topics with the given prefix should be deleted before trying to create new ones (deletes all existing topics if no prefix is given)",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"cleanup",
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManagerDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "Flow worker JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Flow worker minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "Flow worker JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation",
"stateManagerDbConnectionPool"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | ec35033c8427df184ac624a2bc34406febd329b4 | 2023-10-06T07:29:56 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
},
"stateManager": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "STATE_MANAGER",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "STATE_MANAGER",
"examples": [
"STATE_MANAGER"
],
"minLength": 1,
"title": "the schema in which the State Manager entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "State Manager db configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManagerDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "Flow worker JDBC connection pool size for State Manager DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Flow worker minimum JDBC connection pool size for State Manager DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "Flow worker JDBC connection pool configuration for State Manager DB",
"type": "object"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation",
"stateManagerDbConnectionPool"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 90e632e45a050ab7e7a15aa6dbfcaaaf46c336a6 | 2024-02-07T20:25:40 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"basicAuthConfig": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "Configuration for which username and password may be provided inline or via a secret",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"connectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetimeSeconds\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "Maximum pool size",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum pool size (defaults to pool's max size value when null)"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "Connection pool configuration for JDBC connections",
"type": "object"
},
"databaseEngine": {
"default": "postgresql",
"enum": [
"postgresql"
],
"title": "The Database Engine Type",
"type": "string"
},
"databaseTemplate": {
"additionalProperties": false,
"default": {},
"properties": {
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "The database host"
},
"id": {
"minLength": 1,
"type": "string"
},
"name": {
"minLength": 1,
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "The database port",
"type": "integer"
},
"type": {
"$ref": "#/$defs/databaseEngine"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"id",
"username",
"password"
],
"title": "Connection settings for databases used by the Platform",
"type": "object"
},
"stateManagerRuntimeConnectionSettings": {
"additionalProperties": false,
"default": {},
"if": {
"properties": {
"type": {
"const": "Database"
}
}
},
"properties": {
"connectionPool": {},
"password": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage used by the State Manager instance",
"type": "string"
},
"username": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
}
},
"required": [
"type"
],
"then": {
"properties": {
"connectionPool": {
"$ref": "#/$defs/connectionPool",
"default": {},
"title": "JDBC connection pool configuration for the State Manager instance"
}
}
},
"title": "Runtime connection settings for a given State Manager instance and Persistent Storage",
"type": "object"
},
"stateTypePersistentStorageMapping": {
"additionalProperties": false,
"default": {},
"properties": {
"partition": {
"default": "default",
"minLength": 1,
"title": "The name of the internal representation (schema, region, partition, namespace, etc.) within the persistent storage that will be used to manage states",
"type": "string"
},
"storageId": {
"default": "default",
"minLength": 1,
"title": "The id of the persistent storage, defined elsewhere, that will be used to manage states",
"type": "string"
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage used by the State Manager instance",
"type": "string"
}
},
"required": [
"type",
"storageId",
"partition"
],
"title": "Association between a State Type managed by the State Manager and a defined Persistent Storage",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"commonPodLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all pods created by bootstrap jobs",
"type": "object"
},
"db": {
"$comment": "TODO-[CORE-19372]: should we replace 'cluster', 'crypto' and 'rbac' by the new 'databases' section instead?.",
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"databases": {
"items": {
"$ref": "#/$defs/databaseTemplate"
},
"title": "Administrator credentials per database, used to configure users/roles and grant required runtime permissions",
"type": "array"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector",
"commonPodLabels"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"commonPodLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all pods created by deployments",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"databases": {
"$comment": "At least one 'default' database must be defined",
"contains": {
"properties": {
"id": {
"const": "default",
"type": "string"
}
},
"type": "object"
},
"items": {
"allOf": [
{
"$ref": "#/$defs/databaseTemplate"
}
],
"required": [
"name",
"host",
"port",
"type"
],
"type": "object"
},
"minItems": 1,
"title": "List of databases used by the platform",
"type": "array"
},
"db": {
"$comment": "TODO-[CORE-19372]: should we replace this by the new 'databases' instead?.",
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"$ref": "#/$defs/databaseEngine",
"title": "the cluster database type"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"dropLabels": {
"examples": [
[
"virtualnode_destination"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for labels that Corda should drop across all metrics; if empty, all labels are kept",
"type": "array"
},
"keepNames": {
"examples": [
[
"jvm_.*"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for the names of metrics that Corda should keep; if empty, all metrics are kept",
"type": "array"
},
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"default": {},
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowCheckpoint' states",
"type": "object"
},
"flowMapping": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowMapping' states",
"type": "object"
},
"flowStatus": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowStatus' states",
"type": "object"
},
"keyRotation": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'keyRotation' states",
"type": "object"
},
"p2pSession": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'peerToPeerSession' states",
"type": "object"
},
"tokenPoolCache": {
"$ref": "#/$defs/stateTypePersistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'tokenPoolCache' states",
"type": "object"
}
},
"required": [
"flowCheckpoint",
"flowMapping",
"flowStatus",
"keyRotation",
"p2pSession",
"tokenPoolCache"
],
"title": "Persistent Storage configuration for each State Type managed by the State Manager within the Platform",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"keyRotation": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"keyRotation"
],
"type": "object"
}
},
"required": [
"stateManager",
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowCheckpoint"
],
"type": "object"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"flowMapping": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowMapping"
],
"type": "object"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"p2pSession": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"p2pSession"
],
"type": "object"
}
},
"required": [
"stateManager"
]
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"properties": {
"flowStatus": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
},
"keyRotation": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowStatus",
"keyRotation"
],
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service",
"stateManager"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "token selection worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "token selection worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "token selection worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"sharding": {
"additionalProperties": false,
"default": {
"enabled": false,
"image": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"replicaCount": 2
},
"properties": {
"enabled": {
"default": "false",
"title": "enable sharding of requests",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "registry.k8s.io",
"examples": [
"registry.k8s.io"
],
"minLength": 1,
"title": "sharding image registry",
"type": "string"
},
"repository": {
"examples": [
"ingress-nginx/controller"
],
"minLength": 1,
"title": "sharding image repository",
"type": "string"
},
"tag": {
"default": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98",
"examples": [
"v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
],
"minLength": 1,
"title": "sharding image tag",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "sharding image configuration",
"type": "object"
},
"replicaCount": {
"default": 2,
"examples": [
2
],
"title": "sharding replica count",
"type": "integer"
}
},
"required": [
"enabled",
"image",
"replicaCount"
],
"title": "token selection sharding configuration",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"properties": {
"tokenPoolCache": {
"$ref": "#/$defs/stateManagerRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"tokenPoolCache"
],
"type": "object"
}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka",
"databases",
"stateManager"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 6bc313ba63c7033c11d30f19504804af39b4ea16 | 2023-08-22T08:22:15 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cleanup": false,
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cleanup": {
"default": false,
"examples": [
false,
true
],
"title": "specifies whether existing topics with the given prefix should be deleted before trying to create new ones (deletes all existing topics if no prefix is given)",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"cleanup",
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 656c953d0383d04e7534acb289e6db2877ae565a | 2023-09-11T12:34:50 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"db": {
"cluster": {
"existingSecret": "prereqs-postgresql",
"host": "db.cluster.host=prereqs-postgresql"
}
},
"imagePullSecrets": [
"docker-registry-cred"
],
"kafka": {
"bootstrapServers": "prereqs-kafka:9092"
}
}
],
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "CRYPTO"
},
"enabled": true,
"rbac": {
"dbConnectionPool": {
"maxSize": 5
},
"schema": "RBAC"
}
}
],
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"password": {
"value": "password"
},
"username": {
"value": "username"
}
}
],
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username",
"password"
],
"title": "bootstrap cluster database configuration",
"type": "object"
},
"crypto": {
"additionalProperties": false,
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "CRYPTO",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"additionalProperties": false,
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for crypto DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for crypto DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for crypto DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "CRYPTO",
"examples": [
"CRYPTO"
],
"minLength": 1,
"title": "the schema in which the cluster database crypto entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "crypto configuration",
"type": "object"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"default": {},
"examples": [
{
"dbConnectionPool": {
"maxSize": 5
},
"password": {
"value": "password"
},
"schema": "RBAC",
"username": {
"value": "username"
}
}
],
"properties": {
"dbConnectionPool": {
"default": {},
"examples": [
{
"maxSize": 5
}
],
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "maximum JDBC connection pool size for RBAC DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "minimum JDBC connection pool size for RBAC DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "JDBC connection pool configuration for RBAC DB",
"type": "object"
},
"password": {
"$ref": "#/$defs/config"
},
"schema": {
"default": "RBAC",
"examples": [
"RBAC"
],
"minLength": 1,
"title": "the schema in which the cluster database rbac entities will be stored",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"dbConnectionPool",
"schema"
],
"title": "RBAC configuration",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cleanup": false,
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"cleanup": {
"default": false,
"examples": [
false,
true
],
"title": "specifies whether existing topics with the given prefix should be deleted before trying to create new ones (deletes all existing topics if no prefix is given)",
"type": "boolean"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"cleanup",
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
},
"required": [
"encryption"
],
"title": "config service configuration",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cluster": {
"database": "cordacluster",
"existingSecret": "postgresql-secret",
"host": "prereqs-postgresql",
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"user": "user"
}
}
],
"properties": {
"cluster": {
"additionalProperties": false,
"default": {},
"examples": [
{
"database": "cordacluster",
"host": "postgresql.example.com",
"password": {
"value": "password"
},
"port": 5432,
"schema": "CONFIG",
"type": "postgresql",
"username": {
"value": "user"
}
}
],
"properties": {
"database": {
"default": "cordacluster",
"examples": [
"cordacluster"
],
"minLength": 1,
"title": "the name of the cluster database",
"type": "string"
},
"host": {
"default": "",
"examples": [
"postgresql.example.com"
],
"format": "hostname",
"title": "the cluster database host",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "the cluster database port",
"type": "integer"
},
"schema": {
"default": "CONFIG",
"examples": [
"CONFIG"
],
"minLength": 1,
"title": "the schema in which the cluster database config entities will be stored, passed to workers on startup",
"type": "string"
},
"type": {
"default": "postgresql",
"enum": [
"postgresql"
],
"examples": [
"postgresql"
],
"title": "the cluster database type",
"type": "string"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"host",
"type",
"port",
"username",
"database",
"schema"
],
"title": "cluster database configuration",
"type": "object"
}
},
"required": [
"cluster"
],
"title": "cluster database configuration",
"type": "object"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"podMonitor": {
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "crypto worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "crypto worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "crypto worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "DB worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "DB worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "DB worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "persistence worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "persistence worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "persistence worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"clusterDbConnectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepaliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "uniqueness worker maximum JDBC connection pool size for cluster DB",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uniqueness worker minimum JDBC connection pool size for cluster DB; null value means pool's min size will default to pool's max size value"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepaliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "uniqueness worker JDBC connection pool configuration for cluster DB",
"type": "object"
},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"clusterDbConnectionPool"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"db",
"kafka"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | a72e5b299b92f3ef454d495d75e936ee0bdd7bd4 | 2022-05-23T19:08:25 | applications/workers/worker-common/src/main/resources/net/corda/applications/workers/workercommon/boot/corda.boot.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/configuration/boot/1.0/corda.boot.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "Configuration schema for the boot config. This configures stores the values the worker is bootstrapped with.",
"properties": {
"crypto": {
"description": "Configuration options specific to crypto worker.",
"properties": {},
"type": "object"
},
"db": {
"additionalProperties": false,
"description": "Configuration options related to database.",
"properties": {
"jdbcUrl": {
"description": "The JDBC database URL",
"type": [
"string",
"null"
]
},
"params": {
"description": "Additional db params the worker is bootstrapped with.",
"type": "object"
},
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string",
"null"
]
},
"user": {
"description": "Cluster admin username to connect to the database with.",
"type": [
"string",
"null"
]
}
}
},
"dir": {
"additionalProperties": false,
"description": "Configuration for file system directories.",
"properties": {
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string"
]
},
"tmp": {
"description": "Tmp directory",
"type": [
"string"
]
},
"workspace": {
"description": "Local workspace directory",
"type": [
"string"
]
}
}
},
"instanceId": {
"description": "Unique ID for this worker.",
"minimum": 0,
"type": "integer"
},
"kafka": {
"description": "Configuration options specific to kafka backend.",
"properties": {
"common": {
"description": "Kafka properties that are common between consumers and producers, e.g. connection details, security settings.",
"type": "object"
}
}
},
"reconciliation": {
"description": "Configuration options specific to reconciliation.",
"properties": {
"cpkWriteIntervalMs": {
"description": "Cluster admin username to connect to the database with.",
"type": [
"string",
"null"
]
},
"permissionSummaryIntervalMs": {
"description": "The JDBC database URL",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"rpc": {
"description": "Configuration options specific to rpc worker.",
"properties": {},
"type": "object"
},
"topicPrefix": {
"default": "",
"description": "Topic prefix to apply when connecting to topics.",
"type": "string"
}
},
"title": "Corda Boot Configuration Schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 4f59ae1675933cfdc436992d0bfab61069986593 | 2024-02-14T16:04:27 | charts/corda/values.schema.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$defs": {
"basicAuthConfig": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "Configuration for which username and password may be provided inline or via a secret",
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"value": {
"default": "",
"title": "the value",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"additionalProperties": false,
"properties": {
"key": {
"default": "",
"title": "the key in the secret corresponding to the required value",
"type": "string"
},
"name": {
"default": "",
"title": "the name of the secret",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "a reference to a value in a secret",
"type": "object"
}
},
"title": "an alternative location for the value",
"type": "object"
}
},
"title": "configuration for which a value may be provided inline or via a secret",
"type": "object"
},
"connectionPool": {
"additionalProperties": false,
"default": {},
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"minimum": 0,
"title": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"type": "integer"
},
"keepAliveTimeSeconds": {
"default": 0,
"minimum": 0,
"title": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"type": "integer"
},
"maxLifetimeSeconds": {
"default": 1800,
"minimum": 1,
"title": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetimeSeconds\" timeout, it will be removed from the pool only when it becomes idle",
"type": "integer"
},
"maxSize": {
"default": 5,
"examples": [
5
],
"title": "Maximum pool size",
"type": "integer"
},
"minSize": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum pool size (defaults to pool's max size value when null)"
},
"validationTimeoutSeconds": {
"default": 5,
"minimum": 1,
"title": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"type": "integer"
}
},
"required": [
"maxSize",
"idleTimeoutSeconds",
"maxLifetimeSeconds",
"keepAliveTimeSeconds",
"validationTimeoutSeconds"
],
"title": "Connection pool configuration for JDBC connections",
"type": "object"
},
"databaseEngine": {
"default": "postgresql",
"enum": [
"postgresql"
],
"title": "The Database Engine Type",
"type": "string"
},
"databaseTemplate": {
"additionalProperties": false,
"default": {},
"properties": {
"host": {
"anyOf": [
{
"format": "hostname",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "The database host"
},
"id": {
"minLength": 1,
"type": "string"
},
"name": {
"minLength": 1,
"type": "string"
},
"port": {
"default": 5432,
"examples": [
5432
],
"title": "The database port",
"type": "integer"
},
"type": {
"$ref": "#/$defs/databaseEngine"
}
},
"required": [
"id"
],
"title": "Connection settings for databases used by the Platform",
"type": "object"
},
"persistentStorageMapping": {
"default": {},
"properties": {
"partition": {
"default": "default",
"minLength": 1,
"title": "The name of the internal representation (schema, region, partition, namespace, etc.) within the persistent storage",
"type": "string"
},
"storageId": {
"default": "default",
"minLength": 1,
"title": "The id of the persistent storage, defined elsewhere",
"type": "string"
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage",
"type": "string"
}
},
"required": [
"type",
"storageId",
"partition"
],
"title": "Mapping to a defined Persistent Storage",
"type": "object"
},
"persistentStorageRuntimeConnectionSettings": {
"default": {},
"if": {
"properties": {
"type": {
"const": "Database"
}
}
},
"properties": {
"connectionPool": {},
"password": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
},
"type": {
"default": "Database",
"enum": [
"Database"
],
"title": "The type of the persistent storage",
"type": "string"
},
"username": {
"oneOf": [
{
"$ref": "#/$defs/config"
},
{
"type": "null"
}
]
}
},
"required": [
"type"
],
"then": {
"properties": {
"connectionPool": {
"$ref": "#/$defs/connectionPool",
"default": {},
"title": "JDBC connection pool configuration for the persistent storage"
}
}
},
"title": "Runtime connection settings for a given Persistent Storage",
"type": "object"
},
"worker": {
"default": {},
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-xxx-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for the worker",
"type": "object"
},
"debug": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"suspend": false
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with debug enabled",
"type": "boolean"
},
"suspend": {
"default": false,
"examples": [
false
],
"title": "if debug is enabled, suspend the worker until the debugger is attached",
"type": "boolean"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"suspend"
]
},
"title": "worker debug configuration",
"type": "object"
},
"extraArgs": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "Extra command-line arguments for the worker",
"type": "array"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"corda-os-docker.software.r3.com"
],
"title": "worker image registry, defaults to image.registry",
"type": "string"
},
"repository": {
"examples": [
"corda-os-xxx-worker"
],
"minLength": 1,
"title": "worker image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "worker image configuration",
"type": "object"
},
"javaOptions": {
"type": "string"
},
"kafka": {
"properties": {
"additionalProperties": false,
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
}
},
"title": "kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"level": "warn"
}
],
"properties": {
"level": {
"default": null,
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off",
null
],
"examples": [
"warn"
],
"title": "log level (defaults to logging.level if not specified)",
"type": [
"string",
"null"
]
},
"override": {
"default": "",
"title": "additional Log4j 2 XML configuration",
"type": "string"
}
},
"title": "logging configuration",
"type": "object"
},
"profiling": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "run worker with profiling enabled",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "profiling configuration",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "worker replica count",
"type": "integer"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the worker containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the worker containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the worker containers.",
"type": "object"
}
},
"required": [
"image",
"replicaCount",
"resources"
],
"title": "worker configuration",
"type": "object"
}
},
"$id": "http://corda.net/corda-helm.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"default": {},
"properties": {
"affinity": {
"additionalProperties": {
"type": [
"object"
]
},
"default": {},
"title": "affinity for pod assignment",
"type": "object"
},
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "custom annotations for all workers",
"type": "object"
},
"bootstrap": {
"additionalProperties": false,
"default": {},
"properties": {
"commonPodLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all pods created by bootstrap jobs",
"type": "object"
},
"db": {
"additionalProperties": false,
"default": {},
"properties": {
"clientImage": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "docker.io",
"repository": "postgres",
"tag": "14.4"
}
],
"properties": {
"registry": {
"default": "",
"examples": [
"docker.io"
],
"title": "registry for image containing a db client, used to set up the db",
"type": "string"
},
"repository": {
"default": "postgres",
"examples": [
"postgres"
],
"minLength": 1,
"title": "repository for image containing a db client, used to set up the db",
"type": "string"
},
"tag": {
"default": "14.4",
"examples": [
"14.4"
],
"minLength": 1,
"title": "tag for image containing a db client, used to set up the db",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "db client image",
"type": "object"
},
"crypto": {
"allOf": [
{
"$ref": "#/$defs/persistentStorageMapping"
},
{
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
}
]
},
"databases": {
"items": {
"additionalProperties": false,
"default": {},
"properties": {
"id": {
"minLength": 1,
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"id",
"username",
"password"
],
"title": "Connection settings for databases used by the Platform",
"type": "object"
},
"title": "Administrator credentials per database, used to configure users/roles and grant required runtime permissions",
"type": "array"
},
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether DB bootstrap is enabled as part of installation",
"type": "boolean"
},
"rbac": {
"allOf": [
{
"$ref": "#/$defs/persistentStorageMapping"
},
{
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
}
]
},
"virtualNodes": {
"allOf": [
{
"$ref": "#/$defs/persistentStorageMapping"
},
{
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
}
]
}
},
"required": [
"enabled"
],
"title": "configuration for database bootstrap",
"type": "object"
},
"image": {
"additionalProperties": false,
"default": {},
"examples": [
{
"registry": "",
"repository": "corda-os-plugins",
"tag": ""
}
],
"properties": {
"registry": {
"default": "",
"examples": [
""
],
"title": "CLI image registry; defaults to image.registry",
"type": "string"
},
"repository": {
"default": "corda-os-plugins",
"examples": [
"corda-os-plugins"
],
"minLength": 1,
"title": "CLI image repository",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "CLI default tag; defaults to image.tag",
"type": "string"
}
},
"required": [
"repository"
],
"title": "configuration for CLI image used for bootstrap",
"type": "object"
},
"kafka": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"partitions": 10,
"replicas": 3
}
],
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether Kafka bootstrap is enabled as part of installation",
"type": "boolean"
},
"overrides": {
"default": null,
"examples": [
{
"topics": [
{
"name": "avro.schema",
"partitions": 5
}
]
}
],
"title": "overrides for Kafka topic configuration",
"type": "object"
},
"partitions": {
"default": 10,
"examples": [
10
],
"title": "kafka topic partitions",
"type": "integer"
},
"replicas": {
"default": 3,
"examples": [
3
],
"title": "kafka topic replicas",
"type": "integer"
},
"sasl": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"title": "kafka SASL credentials",
"type": "object"
},
"timeoutSeconds": {
"default": 60,
"minimum": 60,
"title": "Maximum time, in seconds, to wait for Kafka topic creation operation to finish (might vary depending on the amount of partitions and replicas configured)",
"type": "integer"
}
},
"required": [
"enabled"
],
"then": {
"required": [
"partitions",
"replicas"
]
},
"title": "configuration for Kafka bootstrap",
"type": "object"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node selector for the bootstrap containers",
"type": "object"
},
"preinstallCheck": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the preinstall check is enabled",
"type": "boolean"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"properties": {
"create": {
"default": true,
"examples": [
true,
false
],
"title": "indicates whether the service account should be created",
"type": "boolean"
},
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account, if not set and create is true, a name is generated from a template",
"type": "string"
}
},
"required": [
"create",
"name"
],
"title": "configuration for a service account for the preinstall check",
"type": "object"
}
},
"required": [
"enabled",
"serviceAccount"
],
"title": "configuration for the preinstall check",
"type": "object"
},
"rbac": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true
}
],
"properties": {
"enabled": {
"default": true,
"examples": [
false,
true
],
"title": "Enables RBAC roles bootstrapping as part of installation",
"type": "boolean"
}
},
"required": [
"enabled"
],
"title": "RBAC roles bootstrap configuration",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"examples": [
{
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
],
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource limits for the bootstrap containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the CPU/memory resource requests for the bootstrap containers",
"type": "object"
}
},
"required": [
"requests",
"limits"
],
"title": "resource limits and requests configuration for the bootstrap containers",
"type": "object"
},
"restApiAdmin": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"username"
],
"title": "configuration for the initial REST API user created with admin permissions",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": "",
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for the bootstrap containers",
"type": "object"
}
},
"required": [
"preinstallCheck",
"restApiAdmin",
"db",
"kafka",
"image",
"resources",
"nodeSelector",
"commonPodLabels"
],
"title": "configuration for cluster bootstrap",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all deployed objects",
"type": "object"
},
"commonPodLabels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"title": "extra labels to add to all pods created by deployments",
"type": "object"
},
"config": {
"allOf": [
{
"$ref": "#/$defs/persistentStorageMapping"
},
{
"properties": {
"encryption": {
"additionalProperties": false,
"properties": {
"passphrase": {
"$ref": "#/$defs/config"
},
"salt": {
"$ref": "#/$defs/config"
}
},
"required": [
"salt",
"passphrase"
],
"title": "configuration for encryption of configuration",
"type": "object"
}
}
}
],
"required": [
"encryption",
"partition",
"storageId",
"type"
],
"title": "config service configuration",
"type": "object"
},
"containerSecurityContext": {
"default": {},
"properties": {
"allowPrivilegeEscalation": {
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
},
"capabilities": {
"default": {},
"properties": {
"add": {
"description": "added capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"drop": {
"description": "removed capabilities",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
}
},
"title": "linux capabilities for users",
"type": "object"
},
"privileged": {
"examples": [
true
],
"title": "run container in privileged mode",
"type": "boolean"
},
"procMount": {
"description": "denotes the type of proc mount to use for the containers - cannot be set when spec.os.name is windows",
"examples": [
"DefaultProcMount"
],
"type": "string"
},
"readOnlyRootFilesystem": {
"examples": [
true
],
"title": "mount the container's root filesystem as read-only",
"type": "boolean"
},
"runAsGroup": {
"examples": [
"10002"
],
"title": "specify what group ID that processes will run with",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"examples": [
"10001"
],
"title": "specify what user ID that processes will run with",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"corda-lib": {
"additionalProperties": false,
"default": {},
"properties": {
"global": {
"additionalProperties": false,
"default": {},
"properties": {},
"title": "global configuration",
"type": "object"
}
},
"required": [
"global"
],
"title": "configuration for library sub-chart",
"type": "object"
},
"databases": {
"$comment": "At least one 'default' database must be defined",
"contains": {
"properties": {
"id": {
"const": "default",
"type": "string"
}
},
"type": "object"
},
"items": {
"allOf": [
{
"$ref": "#/$defs/databaseTemplate"
}
],
"required": [
"name",
"host",
"port",
"type"
],
"type": "object"
},
"minItems": 1,
"title": "List of databases used by the platform",
"type": "array"
},
"dumpHostPath": {
"default": "",
"examples": [
"/logging"
],
"title": "path on Kubernetes hosts to mount on Corda workers for collecting dumps",
"type": "string"
},
"fullnameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart fullname",
"type": "string"
},
"heapDumpOnOutOfMemoryError": {
"default": false,
"examples": [
false,
true
],
"title": "enables capturing JVM heap dumps from Corda workers on an OutOfMemory error",
"type": "boolean"
},
"image": {
"default": {},
"properties": {
"registry": {
"default": "corda-os-docker.software.r3.com",
"examples": [
"corda-os-docker.software.r3.com"
],
"minLength": 1,
"title": "worker image registry",
"type": "string"
},
"tag": {
"default": "",
"examples": [
""
],
"title": "worker image tag, defaults to Chart appVersion",
"type": "string"
}
},
"required": [
"registry"
],
"title": "worker and CLI image defaults",
"type": "object"
},
"imagePullPolicy": {
"default": "Always",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"examples": [
"Always"
],
"title": "image pull policy",
"type": "string"
},
"imagePullSecrets": {
"default": [],
"examples": [
[]
],
"items": {
"type": "string"
},
"title": "image pull secrets",
"type": "array"
},
"kafka": {
"additionalProperties": false,
"default": {},
"properties": {
"bootstrapServers": {
"default": "",
"examples": [
"prereqs-kafka:9092"
],
"minLength": 1,
"title": "comma-separated list of Kafka bootstrap servers",
"type": "string"
},
"sasl": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": true,
"mechanism": "SCRAM-SHA-256",
"password": {
"value": "password"
},
"username": {
"value": "user"
}
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "enable/disable SASL for client connection to Kafka",
"type": "boolean"
},
"mechanism": {
"default": "",
"examples": [
"SCRAM-SHA-256"
],
"minLength": 1,
"title": "SASL mechanism for client connection to Kafka",
"type": "string"
},
"password": {
"$ref": "#/$defs/config"
},
"username": {
"$ref": "#/$defs/config"
}
},
"required": [
"enabled"
],
"title": "SASL configuration for client connection to Kafka",
"type": "object"
},
"tls": {
"additionalProperties": false,
"default": {},
"properties": {
"enabled": {
"default": false,
"examples": [
false,
true
],
"title": "indicates whether TLS should be used for client connections to Kafka",
"type": "boolean"
},
"truststore": {
"additionalProperties": false,
"default": {},
"properties": {
"password": {
"$ref": "#/$defs/config"
},
"type": {
"default": "PEM",
"enum": [
"PEM",
"JKS"
],
"examples": [
"PEM"
],
"title": "if TLS is enabled, the type of the truststore for client connections to Kafka; one of PEM or JKS",
"type": "string"
},
"valueFrom": {
"additionalProperties": false,
"default": {},
"properties": {
"secretKeyRef": {
"default": {},
"properties": {
"key": {
"default": "",
"title": "The truststore secret key",
"type": "string"
},
"name": {
"default": "",
"title": "The truststore secret name",
"type": "string"
}
},
"required": [
"name",
"key"
],
"title": "The truststore key reference",
"type": "object"
}
},
"required": [
"secretKeyRef"
],
"title": "The truststore secret configuration",
"type": "object"
}
},
"required": [
"valueFrom",
"type"
],
"title": "if TLS is enabled, the truststore configuration for client connections to Kafka",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "tls configuration for client connections to Kafka",
"type": "object"
},
"topicPrefix": {
"default": "",
"examples": [
""
],
"title": "prefix to use for Kafka topic names (to support the use of a single Kafka cluster by multiple Corda clusters)",
"type": "string"
}
},
"required": [
"bootstrapServers",
"topicPrefix",
"tls",
"sasl"
],
"title": "Kafka configuration",
"type": "object"
},
"logging": {
"additionalProperties": false,
"default": {},
"examples": [
{
"format": "json",
"level": "warn"
}
],
"properties": {
"format": {
"default": "json",
"enum": [
"json",
"text"
],
"examples": [
"json"
],
"title": "log format",
"type": "string"
},
"level": {
"default": "warn",
"enum": [
"all",
"trace",
"debug",
"info",
"warn",
"error",
"fatal",
"off"
],
"examples": [
"warn"
],
"title": "log level",
"type": "string"
}
},
"required": [
"format",
"level"
],
"title": "Logging configuration",
"type": "object"
},
"metrics": {
"additionalProperties": false,
"examples": [
{
"scrape": false
}
],
"properties": {
"dropLabels": {
"examples": [
[
"virtualnode_destination"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for labels that Corda should drop across all metrics; if empty, all labels are kept",
"type": "array"
},
"keepNames": {
"examples": [
[
"jvm_.*"
]
],
"items": {
"format": "regex",
"type": "string"
},
"title": "A list of regular expressions for the names of metrics that Corda should keep; if empty, all metrics are kept",
"type": "array"
},
"podMonitor": {
"additionalProperties": false,
"default": {},
"examples": [
{
"enabled": false
}
],
"properties": {
"enabled": {
"default": false,
"examples": [
false
],
"title": "Enable pod monitor creation to identify endpoints to scrape",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"default": {},
"examples": [
{}
],
"title": "Labels that can be used so PodMonitor is discovered by Prometheus",
"type": "object"
}
},
"required": [
"enabled"
],
"title": "Pod monitor configuration",
"type": "object"
},
"scrape": {
"default": true,
"examples": [
true
],
"title": "enable scraping of worker metrics through Prometheus annotations",
"type": "boolean"
}
},
"required": [
"scrape",
"podMonitor"
],
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"examples": [
""
],
"title": "override chart name",
"type": "string"
},
"nodeSelector": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "node labels for pod assignment, see https://kubernetes.io/docs/user-guide/node-selection/",
"type": "object"
},
"podSecurityContext": {
"default": {},
"properties": {
"fsGroup": {
"description": "a special supplemental group that applies to all containers in a pod",
"examples": [
"1000"
],
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "defines behavior of changing ownership and permission of the volume before being exposed inside Pod",
"enum": [
"Always",
"OnRootMismatch"
],
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process",
"examples": [
"10002"
],
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "indicates that the container must run as a non-root user",
"examples": [
true
],
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process",
"examples": [
"10001"
],
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"description": "the seccomp options to use by the containers in this pod - this field cannot be set if spec.os.name is windows",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied",
"type": "string"
}
},
"type": "object"
},
"supplementalGroups": {
"description": "a list of groups applied to the first process run in each container, in addition to the container's primary GID",
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"sysctls": {
"description": "sysctls holds a list of namespaced sysctls used for the pod",
"items": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"windowsOptions": {
"description": "the Windows specific settings applied to all containers",
"properties": {
"gmsaCredentialSpec": {
"description": "this is where the GMSA admission webhook inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "the name of the GMSA credential spec to use",
"type": "string"
},
"hostProcess": {
"description": "determines if a container should be run as a 'Host Process' container",
"type": "string"
},
"runAsUserName": {
"description": "the UserName in Windows to run the entrypoint of the container process",
"type": "string"
}
},
"type": "object"
}
},
"title": "define privilege and access control settings for a pod",
"type": "object"
},
"resources": {
"additionalProperties": false,
"default": {},
"properties": {
"limits": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource limits for the Corda containers",
"type": "object"
},
"requests": {
"additionalProperties": false,
"default": {},
"examples": [
{
"cpu": "1",
"memory": "2048Mi"
}
],
"properties": {
"cpu": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"required": [],
"title": "the default CPU/memory resource request for the Corda containers",
"type": "object"
}
},
"required": [
"limits",
"requests"
],
"title": "default resource limits and requests configuration for the Corda containers",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"default": {},
"examples": [
{}
],
"properties": {
"name": {
"default": "",
"examples": [
""
],
"title": "name of the service account",
"type": "string"
}
},
"required": [
"name"
],
"title": "service account for pod assignment, see https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"default": {},
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowCheckpoint' states",
"type": "object"
},
"flowMapping": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowMapping' states",
"type": "object"
},
"flowStatus": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'flowStatus' states",
"type": "object"
},
"keyRotation": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'keyRotation' states",
"type": "object"
},
"p2pSession": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'peerToPeerSession' states",
"type": "object"
},
"tokenPoolCache": {
"$ref": "#/$defs/persistentStorageMapping",
"title": "Persistent Storage configuration to be used by the State Manager when dealing with 'tokenPoolCache' states",
"type": "object"
}
},
"required": [
"flowCheckpoint",
"flowMapping",
"flowStatus",
"keyRotation",
"p2pSession",
"tokenPoolCache"
],
"title": "Persistent Storage configuration for each State Type managed by the State Manager within the Platform",
"type": "object"
},
"tolerations": {
"additionalProperties": false,
"default": [],
"examples": [
{
"effect": "NoSchedule",
"key": "corda",
"operator": "Equal",
"value": "testing"
}
],
"properties": {
"effect": {
"default": "",
"examples": [
"NoSchedule"
],
"title": "toleration effect",
"type": "string"
},
"key": {
"default": "",
"examples": [
"corda"
],
"title": "toleration key",
"type": "string"
},
"operator": {
"default": "Equal",
"examples": [
"Equal"
],
"title": "toleration operator",
"type": "string"
},
"value": {
"default": "",
"examples": [
"testing"
],
"title": "toleration value",
"type": "string"
}
},
"required": [
"key",
"effect"
],
"title": "custom tolerations for all workers and bootstrap jobs",
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"items": {
"type": [
"string",
"object",
"array"
]
},
"title": "topology spread constraints",
"type": "array"
},
"tracing": {
"additionalProperties": false,
"examples": [
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "10"
},
{
"endpoint": "http://tempo:9411",
"samplesPerSecond": "unlimited"
}
],
"properties": {
"endpoint": {
"default": "",
"examples": [
"http://tempo:9411"
],
"title": "URL for endpoint to send Zipkin-format distributed traces to",
"type": "string"
},
"samplesPerSecond": {
"default": "1",
"examples": [
"10",
"unlimited"
],
"title": "Number of request traces to sample per second, defaults to 1 sample per second. Set to 'unlimited' to record all traces, but in this case amount of tracing data produced can be quite vast.",
"type": "string"
}
},
"required": [
"endpoint"
],
"title": "Distributed tracing configuration",
"type": "object"
},
"workers": {
"additionalProperties": false,
"default": {},
"examples": [
{
"crypto": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-crypto-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"db": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"flow": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"flowMapper": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
},
"membership": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-member-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"p2pGateway": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
},
"p2pLinkManager": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"persistence": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"rest": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
},
"uniqueness": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
},
"verification": {
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
}
],
"properties": {
"crypto": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"config": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
},
"debug": {},
"extraArgs": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"keyRotation": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"keyRotation"
],
"type": "object"
}
},
"required": [
"stateManager",
"config"
]
}
]
},
"db": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-db-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"config": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
},
"debug": {},
"extraArgs": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"flow": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"extraArgs": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"flowCheckpoint": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowCheckpoint"
],
"type": "object"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"flowMapper": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-flow-mapper-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"extraArgs": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"flowMapping": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowMapping"
],
"type": "object"
},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run flow mapper worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"stateManager",
"verifyInstrumentation"
]
}
]
},
"membership": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"debug": {},
"extraArgs": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
}
}
]
},
"p2pGateway": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-gateway-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"port": 8080
}
}
],
"properties": {
"annotations": {},
"debug": {},
"extraArgs": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"p2p-gateway-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for P2P gateway worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the P2P gateway worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"p2p-gateway-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for P2P gateway worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "P2P gateway worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"port": 8080
}
],
"properties": {
"port": {
"default": 8080,
"examples": [
8080
],
"title": "the Gateway HTTP port",
"type": "integer"
}
},
"required": [
"port"
],
"title": "p2p-gateway worker worker service configuration",
"type": "object"
}
}
}
]
},
"p2pLinkManager": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-p2p-link-manager-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"debug": {},
"extraArgs": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"stateManager": {
"additionalProperties": false,
"properties": {
"p2pSession": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"p2pSession"
],
"type": "object"
}
},
"required": [
"stateManager"
]
}
]
},
"persistence": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-persistence-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"config": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
},
"debug": {},
"extraArgs": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"config"
]
}
]
},
"rest": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-rest-worker",
"tag": ""
},
"ingress": {
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"service": {
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
}
],
"properties": {
"annotations": {},
"debug": {},
"extraArgs": {},
"image": {},
"ingress": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
},
"className": "nginx",
"hosts": [
"rest-worker-1234.dev.corda.cloud"
]
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{
"cert-manager.io/cluster-issuer": "production",
"nginx.ingress.kubernetes.io/backend-protocol": "HTTPS"
}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker ingress",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "the className for the REST worker ingress",
"type": "string"
},
"hosts": {
"default": [],
"examples": [
[
"rest-worker-1234.dev.corda.cloud"
]
],
"items": {},
"title": "the hosts for REST worker ingress",
"type": "array"
}
},
"required": [
"annotations",
"hosts"
],
"title": "REST worker ingress configuration",
"type": "object"
},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"service": {
"additionalProperties": false,
"default": {},
"examples": [
{
"annotations": {},
"externalTrafficPolicy": "",
"loadBalancerSourceRanges": [],
"port": 443,
"type": "ClusterIP"
}
],
"properties": {
"annotations": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "the annotations for REST worker service",
"type": "object"
},
"externalTrafficPolicy": {
"default": "",
"examples": [
""
],
"title": "the traffic policy for the REST worker service",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "the LoadBalancer source ranges to limit access to the REST worker service",
"type": "array"
},
"port": {
"default": 443,
"examples": [
443
],
"title": "the HTTP port for the REST worker service",
"type": "integer"
},
"type": {
"default": "",
"examples": [
"ClusterIP"
],
"title": "the type for the REST worker service",
"type": "string"
}
},
"required": [
"type",
"externalTrafficPolicy",
"loadBalancerSourceRanges",
"annotations"
],
"title": "REST worker service configuration",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"properties": {
"flowStatus": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
},
"keyRotation": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"flowStatus",
"keyRotation"
],
"type": "object"
},
"tls": {
"additionalProperties": false,
"properties": {
"ca": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the CA certificate chain value",
"type": "string"
}
},
"title": "Certification Authority(CA) certificates chain configuration"
},
"crt": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the certificate value",
"type": "string"
}
},
"title": "TLS Certificate configuration"
},
"generation": {
"additionalProperties": false,
"properties": {
"altNames": {
"title": "Alternative names to be included in a certificate when generated.",
"type": "array"
}
},
"title": "Optional parameters to be used during TLS certificate generation.",
"type": "object"
},
"key": {
"additionalProperties": false,
"properties": {
"secretKey": {
"default": "",
"title": "the key in the secret corresponding to the private key value",
"type": "string"
}
},
"title": "TLS Certificate private key configuration"
},
"secretName": {
"default": "",
"title": "The name of the Kubernetes secret containing the certificate, private key and CA certificate. If not specified, a new secret will be created and certificates/keys generated.",
"type": "string"
}
},
"title": "REST Worker TLS configuration",
"type": "object"
}
},
"required": [
"service",
"stateManager"
]
}
]
},
"tokenSelection": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-token-selection-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"config": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
},
"debug": {},
"extraArgs": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"sharding": {
"additionalProperties": false,
"default": {
"enabled": false,
"image": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"replicaCount": 2
},
"properties": {
"enabled": {
"default": "false",
"title": "enable sharding of requests",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"default": {
"registry": "registry.k8s.io",
"repository": "ingress-nginx/controller",
"tag": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
},
"examples": [
{
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-xxx-worker",
"tag": ""
}
],
"properties": {
"registry": {
"default": "registry.k8s.io",
"examples": [
"registry.k8s.io"
],
"minLength": 1,
"title": "sharding image registry",
"type": "string"
},
"repository": {
"examples": [
"ingress-nginx/controller"
],
"minLength": 1,
"title": "sharding image repository",
"type": "string"
},
"tag": {
"default": "v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98",
"examples": [
"v1.9.3@sha256:8fd21d59428507671ce0fb47f818b1d859c92d2ad07bb7c947268d433030ba98"
],
"minLength": 1,
"title": "sharding image tag",
"type": "string"
}
},
"required": [
"registry",
"repository",
"tag"
],
"title": "sharding image configuration",
"type": "object"
},
"replicaCount": {
"default": 2,
"examples": [
2
],
"title": "sharding replica count",
"type": "integer"
}
},
"required": [
"enabled",
"image",
"replicaCount"
],
"title": "token selection sharding configuration",
"type": "object"
},
"stateManager": {
"additionalProperties": false,
"properties": {
"tokenPoolCache": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings",
"type": "object"
}
},
"required": [
"tokenPoolCache"
],
"type": "object"
}
},
"required": [
"config"
]
}
]
},
"uniqueness": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "",
"repository": "corda-os-uniqueness-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
}
}
],
"properties": {
"annotations": {},
"config": {
"$ref": "#/$defs/persistentStorageRuntimeConnectionSettings"
},
"debug": {},
"extraArgs": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {}
},
"required": [
"config"
]
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/$defs/worker"
},
{
"additionalProperties": false,
"examples": [
{
"debug": {
"enabled": false,
"suspend": false
},
"image": {
"registry": "corda-os-docker.software.r3.com",
"repository": "corda-os-verification-worker",
"tag": ""
},
"logging": {
"level": "warn"
},
"profiling": {
"enabled": false
},
"replicaCount": 1,
"resources": {
"limits": {
"cpu": "1",
"memory": "2048Mi"
},
"requests": {
"cpu": "1",
"memory": "2048Mi"
}
},
"verifyInstrumentation": false
}
],
"properties": {
"annotations": {},
"debug": {},
"extraArgs": {},
"image": {},
"javaOptions": {},
"kafka": {},
"logging": {},
"profiling": {},
"replicaCount": {},
"resources": {},
"verifyInstrumentation": {
"default": false,
"examples": [
false
],
"title": "run verification worker with Quasar's verifyInstrumentation enabled",
"type": "boolean"
}
},
"required": [
"verifyInstrumentation"
]
}
]
}
},
"required": [
"crypto",
"db",
"flow",
"flowMapper",
"verification",
"membership",
"rest",
"p2pLinkManager",
"p2pGateway",
"persistence",
"uniqueness"
],
"title": "worker configuration",
"type": "object"
}
},
"required": [
"kafka",
"databases",
"stateManager"
],
"title": "Corda helm chart schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 01a9b434b69ff38a14c0efcd11a9adac110271d0 | 2023-07-25T12:26:32 | libs/packaging/packaging-verify/src/main/resources/corda-cpk-2.0.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/packaging/cpk/2.0/corda.cpk.dependencies.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "Schema for CPK dependencies",
"properties": {
"dependencies": {
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"verifyFileHash"
]
},
{
"required": [
"verifySameSignerAsMe"
]
}
],
"properties": {
"name": {
"description": "CPK name",
"type": "string"
},
"verifyFileHash": {
"description": "File hash of third party CPK",
"properties": {
"algorithm": {
"description": "Hash algorithm name",
"type": "string"
},
"fileHash": {
"description": "Base64 encoded hash",
"type": "string"
}
},
"required": [
"algorithm",
"fileHash"
],
"type": "object"
},
"verifySameSignerAsMe": {
"description": "Used for dependencies built by the same developer",
"enum": [
true
]
},
"version": {
"description": "CPK version",
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
"type": "array"
},
"formatVersion": {
"type": "string"
}
},
"required": [
"formatVersion",
"dependencies"
],
"title": "Corda CPK 2.0 Schema",
"type": "object"
} | Apache-2.0 | en |
corda/corda-runtime-os | 04319f9cbf6332b86811ee9f66d116cb1e21073e | 2023-10-10T08:32:07 | applications/workers/worker-common/src/main/resources/net/corda/applications/workers/workercommon/boot/corda.boot.json | 60 | 2024-05-28T05:37:57.631894Z | {
"$id": "https://corda.r3.com/net/corda/schema/configuration/boot/1.0/corda.boot.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "Configuration schema for the boot config. This configures stores the values the worker is bootstrapped with.",
"properties": {
"crypto": {
"description": "Configuration options specific to crypto worker.",
"properties": {},
"type": "object"
},
"db": {
"additionalProperties": false,
"description": "Configuration options related to database.",
"properties": {
"bus": {
"description": "Details about the bus type if it is backed by a DB",
"properties": {
"busType": {
"description": "The type of DB message bus. e.g INMEMORY or DATABASE",
"type": [
"string",
"null"
]
}
}
},
"database": {
"description": "Database params",
"properties": {
"jdbc": {
"description": "The JDBC database info",
"properties": {
"directory": {
"description": "The JDBC directory",
"type": [
"string",
"null"
]
},
"url": {
"description": "The JDBC URL used by the db worker",
"type": [
"string",
"null"
]
},
"url_messagebus": {
"description": "The JDBC URL for the message bus if the bus is backed by a DB",
"type": [
"string",
"null"
]
}
}
},
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string",
"null"
]
},
"user": {
"description": "Cluster admin username to connect to the database with.",
"type": [
"string",
"null"
]
}
}
}
}
},
"dir": {
"additionalProperties": false,
"description": "Configuration for file system directories.",
"properties": {
"pass": {
"description": "Cluster admin password to connect to the database with.",
"type": [
"string"
]
},
"tmp": {
"description": "Tmp directory",
"type": [
"string"
]
},
"workspace": {
"description": "Local workspace directory",
"type": [
"string"
]
}
}
},
"instanceId": {
"description": "Unique ID for this worker.",
"minimum": 0,
"type": "integer"
},
"kafka": {
"description": "Configuration options specific to kafka backend.",
"properties": {
"common": {
"description": "Kafka properties that are common between consumers and producers, e.g. connection details, security settings.",
"type": "object"
}
}
},
"maxAllowedMessageSize": {
"default": 972800,
"description": "Maximum allowed size, in bytes, for publishing Messages. This is required for initial push of config to Kafka.",
"maximum": 8388608,
"minimum": 512000,
"type": "integer"
},
"rest": {
"description": "Configuration options related to REST worker.",
"properties": {
"tls": {
"description": "Transport Layer Security (TLS) params",
"properties": {
"ca": {
"description": "Certification Authority Certificate chain in PEM format",
"properties": {
"crt": {
"properties": {
"path": {
"description": "File path to the Certification Authority Certificate chain in PEM format",
"type": [
"string",
"null"
]
}
}
}
}
},
"crt": {
"description": "Certificate to use in PEM format",
"properties": {
"path": {
"description": "File path to the certificate in PEM format",
"type": [
"string",
"null"
]
}
}
},
"key": {
"description": "Private key to use in PEM format",
"properties": {
"path": {
"description": "File path to the private key in PEM format",
"type": [
"string",
"null"
]
}
}
},
"keystore": {
"description": "Keystore info",
"properties": {
"password": {
"description": "The password for the Keystore",
"type": [
"string",
"null"
]
},
"path": {
"description": "Path to a Keystore file",
"type": [
"string",
"null"
]
}
}
}
}
}
}
},
"stateManager": {
"additionalProperties": true,
"description": "Configuration options for the state manager.",
"properties": {
"database": {
"additionalProperties": false,
"description": "Connection parameters when using database as the persistent storage",
"properties": {
"jdbc": {
"additionalProperties": false,
"description": "The JDBC database info",
"properties": {
"additionalProperties": false,
"directory": {
"description": "The JDBC directory to use by the state manager when using database as the persistent storage",
"type": [
"string",
"null"
]
},
"driver": {
"description": "The JDBC driver to use by the state manager when using database as the persistent storage",
"type": [
"string",
"null"
]
},
"url": {
"description": "The JDBC URL to use by the state manager when using database as the persistent storage",
"type": [
"string",
"null"
]
}
}
},
"pass": {
"description": "Admin password to use by the state manager when connecting to the database used as the persistent storage",
"type": [
"string",
"null"
]
},
"pool": {
"additionalProperties": false,
"description": "State Manager database pool connection properties",
"properties": {
"idleTimeoutSeconds": {
"default": 120,
"description": "Maximum time (in seconds) a connection can stay idle in the pool; A value of 0 means that idle connections are never removed from the pool",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"keepAliveTimeSeconds": {
"default": 0,
"description": "Interval time (in seconds) in which connections will be tested for aliveness; Connections which are no longer alive are removed from the pool; A value of 0 means this check is disabled",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"maxLifetimeSeconds": {
"default": 1800,
"description": "Maximum time (in seconds) a connection can stay in the pool, regardless if it has been idle or has been recently used; If a connection is in-use and has reached \"maxLifetime\" timeout, it will be removed from the pool only when it becomes idle",
"minimum": 1,
"type": [
"integer",
"null"
]
},
"maxSize": {
"default": 5,
"description": "Maximum connection pool size for State Manager DB",
"type": [
"integer",
"null"
]
},
"minSize": {
"default": 0,
"description": "Minimum connection pool size for State Manager DB",
"type": [
"integer",
"null"
]
},
"validationTimeoutSeconds": {
"default": 5,
"description": "Maximum time (in seconds) that the pool will wait for a connection to be validated as alive",
"minimum": 1,
"type": [
"integer",
"null"
]
}
}
},
"user": {
"description": "Admin username to use by the state manager when connecting to the database used as the persistent storage",
"type": [
"string",
"null"
]
}
}
},
"type": {
"description": "The type of state manager.",
"type": [
"string",
"null"
]
}
}
},
"topicPrefix": {
"default": "",
"description": "Topic prefix to apply when connecting to topics.",
"type": "string"
}
},
"title": "Corda Boot Configuration Schema",
"type": "object"
} | Apache-2.0 | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.