Skip to content

Commit

Permalink
Deploying to gh-pages from @ 5e8fad2 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
guillaume-dequenne-sonarsource committed Mar 21, 2024
1 parent 23e1cdd commit b01d230
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 17 deletions.
16 changes: 8 additions & 8 deletions rules/S6953/azureresourcemanager-description.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ <h2 id="_description">Description</h2>
This is a way to restrict the input values provided when deploying or updating a resource using the template.</p>
</div>
<div class="paragraph">
<p>However, when it comes to the <code>location</code> parameter, this practice can lead to a code smell.
<p>However, when it comes to a parameter defining the <code>location</code> of a resource, this practice can lead to a code smell.
Users may be unable to deploy such a template if their desired location is not included in the <code>allowedValues</code>.</p>
</div>
</div>
Expand All @@ -17,7 +17,7 @@ <h2 id="_why_is_this_an_issue">Why is this an issue?</h2>
<div class="sectionbody">
<div class="paragraph">
<p>In Azure Resource Manager (ARM) templates, it is possible to set <code>allowedValues</code> for various parameters to limit the options and maintain control.
However, when it comes to the <code>location</code> parameter, this practice can lead to a code smell.
However, when it comes to a parameter defining the <code>location</code> of a resource, this practice can lead to a code smell.
Specifically, setting <code>allowedValues</code> for a location parameter can cause issues because the locations list might not be exhaustive or suitable for all users.
Users may be unable to deploy such a template if their desired location is not included in the <code>allowedValues</code>, causing inconvenience and potential delays in their work.</p>
</div>
Expand All @@ -27,7 +27,7 @@ <h2 id="_why_is_this_an_issue">Why is this an issue?</h2>
<h2 id="_how_to_fix_it_in_arm_templates">How to fix it in ARM Templates</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Remove <code>allowedValues</code> for the location parameter.</p>
<p>Remove <code>allowedValues</code> for the parameter specifying the location.</p>
</div>
<div class="sect2">
<h3 id="_code_examples">Code examples</h3>
Expand Down Expand Up @@ -85,7 +85,7 @@ <h4 id="_compliant_solution">Compliant solution</h4>
<h2 id="_how_to_fix_it_in_bicep">How to fix it in Bicep</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Remove <code>allowedValues</code> for the location parameter.</p>
<p>Remove <code>allowedValues</code> for the parameter specifying the location.</p>
</div>
<div class="sect2">
<h3 id="_code_examples_2">Code examples</h3>
Expand Down Expand Up @@ -140,19 +140,19 @@ <h2 id="_implementation_specification">Implementation Specification</h2>
<div class="sect2">
<h3 id="_message">Message</h3>
<div class="paragraph">
<p>For ARM JSON: Remove this <code>allowedValues</code> property from the <code>location</code> parameter.</p>
<p>For ARM Templates: Remove this <code>allowedValues</code> property from the parameter specifying the location.</p>
</div>
<div class="paragraph">
<p>For Bicep: Remove this <code>@allowed</code> decorator from the <code>location</code> parameter.</p>
<p>For Bicep: Remove this <code>@allowed</code> decorator from the parameter specifying the location.</p>
</div>
</div>
<div class="sect2">
<h3 id="_highlighting">Highlighting</h3>
<div class="paragraph">
<p>In case of AMR JSON, highlight the <code>allowedValues</code> property in the <code>location</code> parameter.</p>
<p>In case of ARM Tempates , highlight the <code>allowedValues</code> property in the parameter specifying the location.</p>
</div>
<div class="paragraph">
<p>In case of Bicep, highlight the <code>@allowed</code> decorator above the <code>location</code> parameter.</p>
<p>In case of Bicep, highlight the <code>@allowed</code> decorator above the parameter specifying the location.</p>
</div>
</div>
</div>
Expand Down
16 changes: 8 additions & 8 deletions rules/S6953/default-description.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ <h2 id="_description">Description</h2>
This is a way to restrict the input values provided when deploying or updating a resource using the template.</p>
</div>
<div class="paragraph">
<p>However, when it comes to the <code>location</code> parameter, this practice can lead to a code smell.
<p>However, when it comes to a parameter defining the <code>location</code> of a resource, this practice can lead to a code smell.
Users may be unable to deploy such a template if their desired location is not included in the <code>allowedValues</code>.</p>
</div>
</div>
Expand All @@ -17,7 +17,7 @@ <h2 id="_why_is_this_an_issue">Why is this an issue?</h2>
<div class="sectionbody">
<div class="paragraph">
<p>In Azure Resource Manager (ARM) templates, it is possible to set <code>allowedValues</code> for various parameters to limit the options and maintain control.
However, when it comes to the <code>location</code> parameter, this practice can lead to a code smell.
However, when it comes to a parameter defining the <code>location</code> of a resource, this practice can lead to a code smell.
Specifically, setting <code>allowedValues</code> for a location parameter can cause issues because the locations list might not be exhaustive or suitable for all users.
Users may be unable to deploy such a template if their desired location is not included in the <code>allowedValues</code>, causing inconvenience and potential delays in their work.</p>
</div>
Expand All @@ -27,7 +27,7 @@ <h2 id="_why_is_this_an_issue">Why is this an issue?</h2>
<h2 id="_how_to_fix_it_in_arm_templates">How to fix it in ARM Templates</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Remove <code>allowedValues</code> for the location parameter.</p>
<p>Remove <code>allowedValues</code> for the parameter specifying the location.</p>
</div>
<div class="sect2">
<h3 id="_code_examples">Code examples</h3>
Expand Down Expand Up @@ -85,7 +85,7 @@ <h4 id="_compliant_solution">Compliant solution</h4>
<h2 id="_how_to_fix_it_in_bicep">How to fix it in Bicep</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Remove <code>allowedValues</code> for the location parameter.</p>
<p>Remove <code>allowedValues</code> for the parameter specifying the location.</p>
</div>
<div class="sect2">
<h3 id="_code_examples_2">Code examples</h3>
Expand Down Expand Up @@ -140,19 +140,19 @@ <h2 id="_implementation_specification">Implementation Specification</h2>
<div class="sect2">
<h3 id="_message">Message</h3>
<div class="paragraph">
<p>For ARM JSON: Remove this <code>allowedValues</code> property from the <code>location</code> parameter.</p>
<p>For ARM Templates: Remove this <code>allowedValues</code> property from the parameter specifying the location.</p>
</div>
<div class="paragraph">
<p>For Bicep: Remove this <code>@allowed</code> decorator from the <code>location</code> parameter.</p>
<p>For Bicep: Remove this <code>@allowed</code> decorator from the parameter specifying the location.</p>
</div>
</div>
<div class="sect2">
<h3 id="_highlighting">Highlighting</h3>
<div class="paragraph">
<p>In case of AMR JSON, highlight the <code>allowedValues</code> property in the <code>location</code> parameter.</p>
<p>In case of ARM Tempates , highlight the <code>allowedValues</code> property in the parameter specifying the location.</p>
</div>
<div class="paragraph">
<p>In case of Bicep, highlight the <code>@allowed</code> decorator above the <code>location</code> parameter.</p>
<p>In case of Bicep, highlight the <code>@allowed</code> decorator above the parameter specifying the location.</p>
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion rules/rule-index.json

Large diffs are not rendered by default.

0 comments on commit b01d230

Please sign in to comment.