microsoft
/
PSRule.Rules.Azure
зеркало из https://github.com/Azure/PSRule.Rules.Azure.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Update docs (#2166)

This commit is contained in:
Bernie White 2023-04-23 23:30:32 +10:00 коммит произвёл GitHub
Родитель 590bdfe99e
Коммит 2a8ce568a3
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
32 изменённых файлов: 70 добавлений и 61 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

6
README.md
Просмотреть файл

@ -8,7 +8,7 @@ Features of PSRule for Azure include:
- [Learn by example][6] - Fix issues quickly, and learn how to improve your Infrastructure as Code..
- [Framework aligned][7] - Apply principals of Azure Well-Architected Framework to your workloads.
- [Start day one][2] - Leverage over 350 pre-built rules to test Azure resources.
- [Start day one][2] - Leverage over 360 pre-built rules to test Azure resources.
- [DevOps integrated][3] - Test Azure infrastructure as code such as Bicep or Azure Resource Manager templates.
- [Cross-platform][4] - Run locally or in the cloud on MacOS, Linux, and Windows.
- [Open community][8] - Open source rules for the Azure community.
@ -109,7 +109,7 @@ jobs:
# STEP 2: Run analysis against exported data
- name: Analyze Azure template files
uses: microsoft/ps-rule@v2.8.0
uses: microsoft/ps-rule@v2.8.1
with:
modules: 'PSRule.Rules.Azure' # Analyze objects using the rules within the PSRule.Rules.Azure PowerShell module.
```
@ -326,6 +326,7 @@ The following baselines are included within `PSRule.Rules.Azure`.
- [Azure.GA_2022_06](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.GA_2022_06/) - Baseline for GA rules released June 2022 or prior.
- [Azure.GA_2022_09](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.GA_2022_09/) - Baseline for GA rules released September 2022 or prior.
- [Azure.GA_2022_12](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.GA_2022_12/) - Baseline for GA rules released December 2022 or prior.
- [Azure.GA_2023_03](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.GA_2023_03/) - Baseline for GA rules released March 2023 or prior.
- [Azure.Preview](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.Preview/) - Includes rules for Azure GA and preview features.
- [Azure.Preview_2021_09](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.Preview_2021_09/) - Baseline for rules released September 2021 or prior for Azure preview only features.
- [Azure.Preview_2021_12](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.Preview_2021_12/) - Baseline for rules released December 2021 or prior for Azure preview only features.
@ -333,6 +334,7 @@ The following baselines are included within `PSRule.Rules.Azure`.
- [Azure.Preview_2022_06](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.Preview_2022_06/) - Baseline for rules released June 2022 or prior for Azure preview only features.
- [Azure.Preview_2022_09](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.Preview_2022_09/) - Baseline for rules released September 2022 or prior for Azure preview only features.
- [Azure.Preview_2022_12](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.Preview_2022_12/) - Baseline for rules released December 2022 or prior for Azure preview only features.
- [Azure.Preview_2023_03](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.Preview_2023_03/) - Baseline for rules released March 2023 or prior for Azure preview only features.
- [Azure.MCSB.v1](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.MCSB.v1/) - A baseline aligned to Microsoft Cloud Security Benchmark v1 controls.
## Language reference

2
docs/about.md
Просмотреть файл

@ -19,7 +19,7 @@ PSRule for Azure uses the principles of the Azure Well-Architected Framework (WA
- **Demonstrate** — how you can implement the change with examples.
If you want to write your own tests, you can do that too in your choice of YAML, JSON, or PowerShell.
However with over 350 tests already built, you can identify and fix issues day one.
However with over 360 tests already built, you can identify and fix issues day one.
## Introducing PSRule for Azure

12
docs/creating-your-pipeline.md
Просмотреть файл

@ -32,7 +32,7 @@ Within the root directory of your infrastructure as code repository:
# Analyze Azure resources using PSRule for Azure
- name: Analyze Azure template files
uses: microsoft/ps-rule@v2.8.0
uses: microsoft/ps-rule@v2.8.1
with:
modules: 'PSRule.Rules.Azure'
```
@ -97,7 +97,7 @@ You can use the `inputPath` parameter to limit the analysis to a specific file o
```yaml hl_lines="6"
# Analyze Azure resources using PSRule for Azure
- name: Analyze Azure template files
uses: microsoft/ps-rule@v2.8.0
uses: microsoft/ps-rule@v2.8.1
with:
modules: 'PSRule.Rules.Azure'
inputPath: azure/modules/
@ -137,7 +137,7 @@ See [working with baselines][8] for more information.
```yaml hl_lines="6"
# Analyze Azure resources using PSRule for Azure
- name: Analyze Azure template files
uses: microsoft/ps-rule@v2.8.0
uses: microsoft/ps-rule@v2.8.1
with:
modules: 'PSRule.Rules.Azure'
baseline: Azure.GA_2022_12
@ -177,7 +177,7 @@ To do this, configure the PSRule for Azure step to _continue on error_.
```yaml hl_lines="4"
# Analyze Azure resources using PSRule for Azure
- name: Analyze Azure template files
uses: microsoft/ps-rule@v2.8.0
uses: microsoft/ps-rule@v2.8.1
continue-on-error: true
with:
modules: 'PSRule.Rules.Azure'
@ -216,7 +216,7 @@ You can add additional modules to the `modules` parameter by using comma (`,`) s
```yaml hl_lines="5"
# Analyze Azure resources using PSRule for Azure
- name: Analyze Azure template files
uses: microsoft/ps-rule@v2.8.0
uses: microsoft/ps-rule@v2.8.1
with:
modules: 'PSRule.Rules.Azure,PSRule.Monitor'
```
@ -250,7 +250,7 @@ For details on the formats that are supported see [analysis output][9].
```yaml hl_lines="6-7"
# Analyze Azure resources using PSRule for Azure
- name: Analyze Azure template files
uses: microsoft/ps-rule@v2.8.0
uses: microsoft/ps-rule@v2.8.1
with:
modules: 'PSRule.Rules.Azure'
outputFormat: Sarif

2
docs/en/baselines/Azure.All.md
Просмотреть файл

@ -58,7 +58,7 @@ Name | Synopsis | Severity
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.Ciphers](../rules/Azure.APIM.Ciphers.md) | API Management should not accept weak or deprecated ciphers for client or backend communication. | Critical
[Azure.APIM.CORSPolicy](../rules/Azure.APIM.CORSPolicy.md) | Wildcard * for any configuration option in CORS policies settings should not be used. | Important
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | Encrypt all API Management named values with Key Vault secrets. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

2
docs/en/baselines/Azure.Default.md
Просмотреть файл

@ -53,7 +53,7 @@ Name | Synopsis | Severity
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.Ciphers](../rules/Azure.APIM.Ciphers.md) | API Management should not accept weak or deprecated ciphers for client or backend communication. | Critical
[Azure.APIM.CORSPolicy](../rules/Azure.APIM.CORSPolicy.md) | Wildcard * for any configuration option in CORS policies settings should not be used. | Important
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | Encrypt all API Management named values with Key Vault secrets. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

3
docs/en/baselines/Azure.GA_2020_06.md
Просмотреть файл

@ -6,7 +6,7 @@ Include rules released June 2020 or prior for Azure GA features.
## Rules
The following rules are included within `Azure.GA_2020_06`. This baseline includes a total of 138 rules.
The following rules are included within `Azure.GA_2020_06`. This baseline includes a total of 137 rules.
Name | Synopsis | Severity
---- | -------- | --------
@ -25,7 +25,6 @@ Name | Synopsis | Severity
[Azure.AKS.UseRBAC](../rules/Azure.AKS.UseRBAC.md) | Deploy AKS cluster with role-based access control (RBAC) enabled. | Important
[Azure.AKS.Version](../rules/Azure.AKS.Version.md) | AKS control plane and nodes pools should use a current stable release. | Important
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

3
docs/en/baselines/Azure.GA_2020_09.md
Просмотреть файл

@ -6,7 +6,7 @@ Include rules released September 2020 or prior for Azure GA features.
## Rules
The following rules are included within `Azure.GA_2020_09`. This baseline includes a total of 154 rules.
The following rules are included within `Azure.GA_2020_09`. This baseline includes a total of 153 rules.
Name | Synopsis | Severity
---- | -------- | --------
@ -26,7 +26,6 @@ Name | Synopsis | Severity
[Azure.AKS.Version](../rules/Azure.AKS.Version.md) | AKS control plane and nodes pools should use a current stable release. | Important
[Azure.APIM.APIDescriptors](../rules/Azure.APIM.APIDescriptors.md) | API Management APIs should have a display name and description. | Awareness
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

3
docs/en/baselines/Azure.GA_2020_12.md
Просмотреть файл

@ -6,7 +6,7 @@ Include rules released December 2020 or prior for Azure GA features.
## Rules
The following rules are included within `Azure.GA_2020_12`. This baseline includes a total of 178 rules.
The following rules are included within `Azure.GA_2020_12`. This baseline includes a total of 177 rules.
Name | Synopsis | Severity
---- | -------- | --------
@ -32,7 +32,6 @@ Name | Synopsis | Severity
[Azure.AKS.Version](../rules/Azure.AKS.Version.md) | AKS control plane and nodes pools should use a current stable release. | Important
[Azure.APIM.APIDescriptors](../rules/Azure.APIM.APIDescriptors.md) | API Management APIs should have a display name and description. | Awareness
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

3
docs/en/baselines/Azure.GA_2021_03.md
Просмотреть файл

@ -6,7 +6,7 @@ Include rules released March 2021 or prior for Azure GA features.
## Rules
The following rules are included within `Azure.GA_2021_03`. This baseline includes a total of 193 rules.
The following rules are included within `Azure.GA_2021_03`. This baseline includes a total of 192 rules.
Name | Synopsis | Severity
---- | -------- | --------
@ -32,7 +32,6 @@ Name | Synopsis | Severity
[Azure.AKS.Version](../rules/Azure.AKS.Version.md) | AKS control plane and nodes pools should use a current stable release. | Important
[Azure.APIM.APIDescriptors](../rules/Azure.APIM.APIDescriptors.md) | API Management APIs should have a display name and description. | Awareness
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

3
docs/en/baselines/Azure.GA_2021_06.md
Просмотреть файл

@ -6,7 +6,7 @@ Include rules released June 2021 or prior for Azure GA features.
## Rules
The following rules are included within `Azure.GA_2021_06`. This baseline includes a total of 207 rules.
The following rules are included within `Azure.GA_2021_06`. This baseline includes a total of 206 rules.
Name | Synopsis | Severity
---- | -------- | --------
@ -35,7 +35,6 @@ Name | Synopsis | Severity
[Azure.AKS.Version](../rules/Azure.AKS.Version.md) | AKS control plane and nodes pools should use a current stable release. | Important
[Azure.APIM.APIDescriptors](../rules/Azure.APIM.APIDescriptors.md) | API Management APIs should have a display name and description. | Awareness
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

3
docs/en/baselines/Azure.GA_2021_09.md
Просмотреть файл

@ -6,7 +6,7 @@ Include rules released September 2021 or prior for Azure GA features.
## Rules
The following rules are included within `Azure.GA_2021_09`. This baseline includes a total of 226 rules.
The following rules are included within `Azure.GA_2021_09`. This baseline includes a total of 225 rules.
Name | Synopsis | Severity
---- | -------- | --------
@ -41,7 +41,6 @@ Name | Synopsis | Severity
[Azure.AKS.Version](../rules/Azure.AKS.Version.md) | AKS control plane and nodes pools should use a current stable release. | Important
[Azure.APIM.APIDescriptors](../rules/Azure.APIM.APIDescriptors.md) | API Management APIs should have a display name and description. | Awareness
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

3
docs/en/baselines/Azure.GA_2021_12.md
Просмотреть файл

@ -6,7 +6,7 @@ Include rules released December 2021 or prior for Azure GA features.
## Rules
The following rules are included within `Azure.GA_2021_12`. This baseline includes a total of 252 rules.
The following rules are included within `Azure.GA_2021_12`. This baseline includes a total of 251 rules.
Name | Synopsis | Severity
---- | -------- | --------
@ -46,7 +46,6 @@ Name | Synopsis | Severity
[Azure.APIM.APIDescriptors](../rules/Azure.APIM.APIDescriptors.md) | API Management APIs should have a display name and description. | Awareness
[Azure.APIM.AvailabilityZone](../rules/Azure.APIM.AvailabilityZone.md) | API management services deployed with Premium SKU should use availability zones in supported regions for high availability. | Important
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

3
docs/en/baselines/Azure.GA_2022_03.md
Просмотреть файл

@ -6,7 +6,7 @@ Include rules released March 2022 or prior for Azure GA features.
## Rules
The following rules are included within `Azure.GA_2022_03`. This baseline includes a total of 268 rules.
The following rules are included within `Azure.GA_2022_03`. This baseline includes a total of 267 rules.
Name | Synopsis | Severity
---- | -------- | --------
@ -51,7 +51,6 @@ Name | Synopsis | Severity
[Azure.APIM.AvailabilityZone](../rules/Azure.APIM.AvailabilityZone.md) | API management services deployed with Premium SKU should use availability zones in supported regions for high availability. | Important
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.Ciphers](../rules/Azure.APIM.Ciphers.md) | API Management should not accept weak or deprecated ciphers for client or backend communication. | Critical
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

3
docs/en/baselines/Azure.GA_2022_06.md
Просмотреть файл

@ -6,7 +6,7 @@ Include rules released June 2022 or prior for Azure GA features.
## Rules
The following rules are included within `Azure.GA_2022_06`. This baseline includes a total of 272 rules.
The following rules are included within `Azure.GA_2022_06`. This baseline includes a total of 271 rules.
Name | Synopsis | Severity
---- | -------- | --------
@ -51,7 +51,6 @@ Name | Synopsis | Severity
[Azure.APIM.AvailabilityZone](../rules/Azure.APIM.AvailabilityZone.md) | API management services deployed with Premium SKU should use availability zones in supported regions for high availability. | Important
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.Ciphers](../rules/Azure.APIM.Ciphers.md) | API Management should not accept weak or deprecated ciphers for client or backend communication. | Critical
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

3
docs/en/baselines/Azure.GA_2022_09.md
Просмотреть файл

@ -6,7 +6,7 @@ Include rules released September 2022 or prior for Azure GA features.
## Rules
The following rules are included within `Azure.GA_2022_09`. This baseline includes a total of 305 rules.
The following rules are included within `Azure.GA_2022_09`. This baseline includes a total of 304 rules.
Name | Synopsis | Severity
---- | -------- | --------
@ -53,7 +53,6 @@ Name | Synopsis | Severity
[Azure.APIM.AvailabilityZone](../rules/Azure.APIM.AvailabilityZone.md) | API management services deployed with Premium SKU should use availability zones in supported regions for high availability. | Important
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.Ciphers](../rules/Azure.APIM.Ciphers.md) | API Management should not accept weak or deprecated ciphers for client or backend communication. | Critical
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

3
docs/en/baselines/Azure.GA_2022_12.md
Просмотреть файл

@ -6,7 +6,7 @@ Include rules released December 2022 or prior for Azure GA features.
## Rules
The following rules are included within `Azure.GA_2022_12`. This baseline includes a total of 343 rules.
The following rules are included within `Azure.GA_2022_12`. This baseline includes a total of 342 rules.
Name | Synopsis | Severity
---- | -------- | --------
@ -53,7 +53,6 @@ Name | Synopsis | Severity
[Azure.APIM.AvailabilityZone](../rules/Azure.APIM.AvailabilityZone.md) | API management services deployed with Premium SKU should use availability zones in supported regions for high availability. | Important
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.Ciphers](../rules/Azure.APIM.Ciphers.md) | API Management should not accept weak or deprecated ciphers for client or backend communication. | Critical
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

3
docs/en/baselines/Azure.GA_2023_03.md
Просмотреть файл

@ -4,7 +4,7 @@ Include rules released March 2023 or prior for Azure GA features.
## Rules
The following rules are included within `Azure.GA_2023_03`. This baseline includes a total of 363 rules.
The following rules are included within `Azure.GA_2023_03`. This baseline includes a total of 362 rules.
Name | Synopsis | Severity
---- | -------- | --------
@ -53,7 +53,6 @@ Name | Synopsis | Severity
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.Ciphers](../rules/Azure.APIM.Ciphers.md) | API Management should not accept weak or deprecated ciphers for client or backend communication. | Critical
[Azure.APIM.CORSPolicy](../rules/Azure.APIM.CORSPolicy.md) | Wildcard * for any configuration option in CORS policies settings should not be used. | Important
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

2
docs/en/baselines/Azure.MCSB.v1.md
Просмотреть файл

@ -32,7 +32,7 @@ Name | Synopsis | Severity
[Azure.AKS.Version](../rules/Azure.AKS.Version.md) | AKS control plane and nodes pools should use a current stable release. | Important
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.Ciphers](../rules/Azure.APIM.Ciphers.md) | API Management should not accept weak or deprecated ciphers for client or backend communication. | Critical
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | Encrypt all API Management named values with Key Vault secrets. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

2
docs/en/baselines/Azure.Preview.md
Просмотреть файл

@ -58,7 +58,7 @@ Name | Synopsis | Severity
[Azure.APIM.CertificateExpiry](../rules/Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important
[Azure.APIM.Ciphers](../rules/Azure.APIM.Ciphers.md) | API Management should not accept weak or deprecated ciphers for client or backend communication. | Critical
[Azure.APIM.CORSPolicy](../rules/Azure.APIM.CORSPolicy.md) | Wildcard * for any configuration option in CORS policies settings should not be used. | Important
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important
[Azure.APIM.EncryptValues](../rules/Azure.APIM.EncryptValues.md) | Encrypt all API Management named values with Key Vault secrets. | Important
[Azure.APIM.HTTPBackend](../rules/Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical
[Azure.APIM.HTTPEndpoint](../rules/Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important
[Azure.APIM.ManagedIdentity](../rules/Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important

4
docs/en/rules/index.md
Просмотреть файл

@ -1,6 +1,6 @@
---
title: Reference
generated: True
title: Reference
---
# Reference
@ -66,7 +66,7 @@ AZR-000041 | [Azure.AKS.ContainerInsights](Azure.AKS.ContainerInsights.md) | Ena
AZR-000042 | [Azure.APIM.HTTPEndpoint](Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | GA
AZR-000043 | [Azure.APIM.APIDescriptors](Azure.APIM.APIDescriptors.md) | API Management APIs should have a display name and description. | GA
AZR-000044 | [Azure.APIM.HTTPBackend](Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | GA
AZR-000045 | [Azure.APIM.EncryptValues](Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | GA
AZR-000045 | [Azure.APIM.EncryptValues](Azure.APIM.EncryptValues.md) | Encrypt all API Management named values with Key Vault secrets. | GA
AZR-000046 | [Azure.APIM.ProductSubscription](Azure.APIM.ProductSubscription.md) | Configure products to require a subscription. | GA
AZR-000047 | [Azure.APIM.ProductApproval](Azure.APIM.ProductApproval.md) | Configure products to require approval. | GA
AZR-000048 | [Azure.APIM.SampleProducts](Azure.APIM.SampleProducts.md) | Remove starter and unlimited sample products. | GA

9
docs/en/rules/module.md
Просмотреть файл

@ -8,6 +8,12 @@ PSRule for Azure includes the following rules across five pillars of the Microso
## Cost Optimization
### Governance
Name | Synopsis | Severity | Level
---- | -------- | -------- | -----
[Azure.Resource.UseTags](Azure.Resource.UseTags.md) | Azure resources should be tagged using a standard convention. | Awareness | Error
### Optimize
Name | Synopsis | Severity | Level
@ -205,7 +211,6 @@ Name | Synopsis | Severity | Level
---- | -------- | -------- | -----
[Azure.AKS.DNSPrefix](Azure.AKS.DNSPrefix.md) | Azure Kubernetes Service (AKS) cluster DNS prefix should meet naming requirements. | Awareness | Error
[Azure.PublicIP.DNSLabel](Azure.PublicIP.DNSLabel.md) | Public IP domain name labels should meet naming requirements. | Awareness | Error
[Azure.Resource.UseTags](Azure.Resource.UseTags.md) | Azure resources should be tagged using a standard convention. | Awareness | Error
## Performance Efficiency
@ -452,7 +457,7 @@ Name | Synopsis | Severity | Level
Name | Synopsis | Severity | Level
---- | -------- | -------- | -----
[Azure.ACR.ContentTrust](Azure.ACR.ContentTrust.md) | Use container images signed by a trusted image publisher. | Important | Error
[Azure.APIM.EncryptValues](Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important | Error
[Azure.APIM.EncryptValues](Azure.APIM.EncryptValues.md) | Encrypt all API Management named values with Key Vault secrets. | Important | Error
[Azure.APIM.HTTPEndpoint](Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important | Error
[Azure.AppGw.SSLPolicy](Azure.AppGw.SSLPolicy.md) | Application Gateway should only accept a minimum of TLS 1.2. | Critical | Error
[Azure.AppGw.UseHTTPS](Azure.AppGw.UseHTTPS.md) | Application Gateways should only expose frontend HTTP endpoints over HTTPS. | Critical | Error

2
docs/en/rules/resource.md
Просмотреть файл

@ -46,7 +46,7 @@ Name | Synopsis | Severity | Level
[Azure.APIM.CertificateExpiry](Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important | Error
[Azure.APIM.Ciphers](Azure.APIM.Ciphers.md) | API Management should not accept weak or deprecated ciphers for client or backend communication. | Critical | Error
[Azure.APIM.CORSPolicy](Azure.APIM.CORSPolicy.md) | Wildcard * for any configuration option in CORS policies settings should not be used. | Important | Error
[Azure.APIM.EncryptValues](Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important | Error
[Azure.APIM.EncryptValues](Azure.APIM.EncryptValues.md) | Encrypt all API Management named values with Key Vault secrets. | Important | Error
[Azure.APIM.HTTPBackend](Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical | Error
[Azure.APIM.HTTPEndpoint](Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important | Error
[Azure.APIM.ManagedIdentity](Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important | Error

4
docs/es/rules/index.md
Просмотреть файл

@ -1,6 +1,6 @@
---
title: Reference
generated: True
title: Reference
---
# Reference
@ -66,7 +66,7 @@ AZR-000041 | [Azure.AKS.ContainerInsights](Azure.AKS.ContainerInsights.md) | Ena
AZR-000042 | [Azure.APIM.HTTPEndpoint](Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | GA
AZR-000043 | [Azure.APIM.APIDescriptors](Azure.APIM.APIDescriptors.md) | API Management APIs should have a display name and description. | GA
AZR-000044 | [Azure.APIM.HTTPBackend](Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | GA
AZR-000045 | [Azure.APIM.EncryptValues](Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | GA
AZR-000045 | [Azure.APIM.EncryptValues](Azure.APIM.EncryptValues.md) | Encrypt all API Management named values with Key Vault secrets. | GA
AZR-000046 | [Azure.APIM.ProductSubscription](Azure.APIM.ProductSubscription.md) | Configure products to require a subscription. | GA
AZR-000047 | [Azure.APIM.ProductApproval](Azure.APIM.ProductApproval.md) | Configure products to require approval. | GA
AZR-000048 | [Azure.APIM.SampleProducts](Azure.APIM.SampleProducts.md) | Remove starter and unlimited sample products. | GA

9
docs/es/rules/module.md
Просмотреть файл

@ -8,6 +8,12 @@ PSRule for Azure includes the following rules across five pillars of the Microso
## Cost Optimization
### Governance
Name | Synopsis | Severity | Level
---- | -------- | -------- | -----
[Azure.Resource.UseTags](Azure.Resource.UseTags.md) | Azure resources should be tagged using a standard convention. | Awareness | Error
### Optimize
Name | Synopsis | Severity | Level
@ -205,7 +211,6 @@ Name | Synopsis | Severity | Level
---- | -------- | -------- | -----
[Azure.AKS.DNSPrefix](Azure.AKS.DNSPrefix.md) | Azure Kubernetes Service (AKS) cluster DNS prefix should meet naming requirements. | Awareness | Error
[Azure.PublicIP.DNSLabel](Azure.PublicIP.DNSLabel.md) | Public IP domain name labels should meet naming requirements. | Awareness | Error
[Azure.Resource.UseTags](Azure.Resource.UseTags.md) | Azure resources should be tagged using a standard convention. | Awareness | Error
## Performance Efficiency
@ -452,7 +457,7 @@ Name | Synopsis | Severity | Level
Name | Synopsis | Severity | Level
---- | -------- | -------- | -----
[Azure.ACR.ContentTrust](Azure.ACR.ContentTrust.md) | Use container images signed by a trusted image publisher. | Important | Error
[Azure.APIM.EncryptValues](Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important | Error
[Azure.APIM.EncryptValues](Azure.APIM.EncryptValues.md) | Encrypt all API Management named values with Key Vault secrets. | Important | Error
[Azure.APIM.HTTPEndpoint](Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important | Error
[Azure.AppGw.SSLPolicy](Azure.AppGw.SSLPolicy.md) | Application Gateway should only accept a minimum of TLS 1.2. | Critical | Error
[Azure.AppGw.UseHTTPS](Azure.AppGw.UseHTTPS.md) | Application Gateways should only expose frontend HTTP endpoints over HTTPS. | Critical | Error

2
docs/es/rules/resource.md
Просмотреть файл

@ -46,7 +46,7 @@ Name | Synopsis | Severity | Level
[Azure.APIM.CertificateExpiry](Azure.APIM.CertificateExpiry.md) | Renew certificates used for custom domain bindings. | Important | Error
[Azure.APIM.Ciphers](Azure.APIM.Ciphers.md) | API Management should not accept weak or deprecated ciphers for client or backend communication. | Critical | Error
[Azure.APIM.CORSPolicy](Azure.APIM.CORSPolicy.md) | Wildcard * for any configuration option in CORS policies settings should not be used. | Important | Error
[Azure.APIM.EncryptValues](Azure.APIM.EncryptValues.md) | API Management named values should be encrypted. | Important | Error
[Azure.APIM.EncryptValues](Azure.APIM.EncryptValues.md) | Encrypt all API Management named values with Key Vault secrets. | Important | Error
[Azure.APIM.HTTPBackend](Azure.APIM.HTTPBackend.md) | Use HTTPS for communication to backend services. | Critical | Error
[Azure.APIM.HTTPEndpoint](Azure.APIM.HTTPEndpoint.md) | Enforce HTTPS for communication to API clients. | Important | Error
[Azure.APIM.ManagedIdentity](Azure.APIM.ManagedIdentity.md) | Configure managed identities to access Azure resources. | Important | Error

2
docs/features.md
Просмотреть файл

@ -36,7 +36,7 @@ This allows you to explore and learn the context of each WAF principle.
## Start day one
PSRule for Azure includes over 350 rules for validating resources against configuration recommendations.
PSRule for Azure includes over 360 rules for validating resources against configuration recommendations.
Rules automatically detect and analyze resources from Azure IaC artifacts.
This allows you to quickly light up unit testing of Azure resources from templates and Bicep deployments.

4
docs/install-instructions.md
Просмотреть файл

@ -24,7 +24,7 @@ Install and use PSRule for Azure with GitHub Actions by referencing the `microso
```yaml
- name: Analyze Azure template files
uses: microsoft/ps-rule@v2.8.0
uses: microsoft/ps-rule@v2.8.1
with:
modules: 'PSRule.Rules.Azure'
```
@ -35,7 +35,7 @@ Install and use PSRule for Azure with GitHub Actions by referencing the `microso
```yaml
- name: Analyze Azure template files
uses: microsoft/ps-rule@v2.8.0
uses: microsoft/ps-rule@v2.8.1
with:
modules: 'PSRule.Rules.Azure'
prerelease: true

13
docs/samples.md
Просмотреть файл

@ -1,5 +1,5 @@
---
reviewed: 2022-07-29
reviewed: 2023-04-23
author: BernieWhite
discussion: false
---
@ -20,4 +20,13 @@ This repository contains the following samples for PSRule for Azure:
- **Custom rules** — Example custom rules that enforce organization specific requirements.
- **PSRule options** — Example options for using PSRule for Azure.
[1]: https://github.com/Azure/PSRule.Rules.Azure-quickstart
[1]: https://aka.ms/ps-rule-azure-quickstart
## PSRule samples
[:octicons-repo-24: Samples][2]
A community collection of samples for PSRule.
This repository includes samples for Azure as well as other use cases.
[2]: https://github.com/microsoft/PSRule-samples

4
docs/setup/setup-azure-monitor-logs.md
Просмотреть файл

@ -70,7 +70,7 @@ Import analysis results into Azure Monitor with GitHub Actions by:
```yaml
- name: Analyze Azure template files
uses: microsoft/ps-rule@v2.8.0
uses: microsoft/ps-rule@v2.8.1
with:
modules: PSRule.Rules.Azure,PSRule.Monitor
conventions: Monitor.LogAnalytics.Import
@ -86,7 +86,7 @@ Import analysis results into Azure Monitor with GitHub Actions by:
```yaml
- name: Analyze Azure template files
uses: microsoft/ps-rule@v2.8.0
uses: microsoft/ps-rule@v2.8.1
with:
modules: PSRule.Rules.Azure,PSRule.Monitor
conventions: Monitor.LogAnalytics.Import

2
docs/troubleshooting.md
Просмотреть файл

@ -200,5 +200,5 @@ For the PSRule GitHub Action, use **>=1.4.0**.
```yaml
- name: Run PSRule analysis
uses: microsoft/ps-rule@v2.8.0
uses: microsoft/ps-rule@v2.8.1
```

2
docs/using-bicep.md
Просмотреть файл

@ -270,7 +270,7 @@ Typically, the following three environment variables should be set:
```yaml
- name: Analyze Azure template files
uses: microsoft/ps-rule@v2.8.0
uses: microsoft/ps-rule@v2.8.1
with:
modules: PSRule.Rules.Azure,PSRule.Monitor
conventions: Monitor.LogAnalytics.Import

10
docs/working-with-baselines.md
Просмотреть файл

@ -82,10 +82,10 @@ See [reference][1] for a list baselines shipped with PSRule for Azure.
```yaml
# Analyze Azure resources using PSRule for Azure
- name: Analyze Azure template files
uses: microsoft/ps-rule@v2.8.0
uses: microsoft/ps-rule@v2.8.1
with:
modules: 'PSRule.Rules.Azure'
baseline: 'Azure.GA_2022_12'
baseline: 'Azure.GA_2023_03'
```
=== "Azure Pipelines"
@ -98,7 +98,7 @@ See [reference][1] for a list baselines shipped with PSRule for Azure.
displayName: Analyze Azure template files
inputs:
modules: 'PSRule.Rules.Azure'
baseline: 'Azure.GA_2022_12'
baseline: 'Azure.GA_2023_03'
```
=== "PowerShell"
@ -106,11 +106,11 @@ See [reference][1] for a list baselines shipped with PSRule for Azure.
Update your PowerShell command-line with `-Baseline <name_of_baseline>`.
```powershell title="With Assert-PSRule"
Assert-PSRule -Format File -InputPath '.' -Module 'PSRule.Rules.Azure' -Baseline 'Azure.GA_2022_12'
Assert-PSRule -Format File -InputPath '.' -Module 'PSRule.Rules.Azure' -Baseline 'Azure.GA_2023_03'
```
```powershell title="With Invoke-PSRule"
Invoke-PSRule -Format File -InputPath '.' -Module 'PSRule.Rules.Azure' -Baseline 'Azure.GA_2022_12'
Invoke-PSRule -Format File -InputPath '.' -Module 'PSRule.Rules.Azure' -Baseline 'Azure.GA_2023_03'
```
[1]: en/baselines/Azure.All.md