Merge pull request #5977 from inspec/im/template

Update Hugo resource doc archetype
This commit is contained in:
Ian Maddaus 2022-06-12 23:28:52 -04:00 committed by GitHub
commit 80d504e40e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
195 changed files with 470 additions and 463 deletions

View file

@ -3,51 +3,144 @@
This is the home of the InSpec Documentation that is deployed on
https://docs.chef.io/inspec/ using Hugo modules.
## The Fastest Way to Contribute
## Updating InSpec Docs Content
There are two steps to updating the Chef InSpec documentation:
There are two steps to updating the Chef InSpec documentation on docs.chef.io:
1. Update the documentation in the `inspec/inspec` repository.
1. Update the InSpec repository module in chef-web-docs
1. Update the InSpec [repository module in chef-web-docs](#update-the-inspec-docs-content-on-docchefio).
### Update Content in `inspec/inspec`
## Documentation Content
The fastest way to change the documentation is to edit a page on the
GitHub website using the GitHub UI.
Please keep all of the InSpec documentation in the `content/inspec` directory.
To perform edits using the GitHub UI, click on the `[edit on GitHub]` link at
the top of the page that you want to edit. The link takes you to that topic's GitHub
page. In GitHub, click on the pencil icon and make your changes. You can preview
how they'll look right on the page ("Preview Changes" tab).
The diagram below shows how documentation content should be organized:
We also require contributors to include their [DCO signoff](https://github.com/chef/chef/blob/main/CONTRIBUTING.md#developer-certification-of-origin-dco)
in the comment section of every pull request, except for obvious fixes. You can
add your DCO signoff to the comments by including `Signed-off-by:`, followed by
your name and email address, like this:
```
.
├── docs-chef-io
│   ├── archetypes # page templates
│   ├── content
│   │   ├── inspec # InSpec documentation
│   │ │ ├── resources # InSpec resource documentation
│ ├── static
│ | ├── images
│ │ | ├── inspec # images
│ ├── layouts
│ | ├── shortcodes # reusable text files
```
`Signed-off-by: Julia Child <juliachild@chef.io>`
To add a new Markdown page, run the following command from the `docs-chef-io` directory:
See our [blog post](https://blog.chef.io/introducing-developer-certificate-of-origin/)
for more information about the DCO and why we require it.
```
hugo new content/inspec/FILENAME.md
```
After you've added your DCO signoff, add a comment about your proposed change,
then click on the "Propose file change" button at the bottom of the page and
confirm your pull request. The CI system will do some checks and add a comment
to your PR with the results.
This will create a draft page with enough front matter to get you going.
The Chef documentation team can normally merge pull requests within seven days.
We'll fix build errors before we merge, so you don't have to
worry about passing all the CI checks, but it might add an extra
few days. The important part is submitting your change.
Hugo uses [Goldmark](https://github.com/yuin/goldmark) which is a
superset of Markdown that includes GitHub styled tables, task lists, and
definition lists.
### Update the InSpec Repository Module In `chef/chef-web-docs`
See our [Style Guide](https://docs.chef.io/style_guide/) for more information
about formatting documentation using Markdown.
We use [Hugo modules](https://gohugo.io/hugo-modules/) to build Chef's documentation
from multiple repositories. Expeditor will submit a pull request that updates the documentation
in `chef/chef-web-docs` the next time InSpec is promoted.
### Page Front Matter
The Docs Team can also update the InSpec documentation if changes need to be made
before the next promotion.
At the top of each page is a block of front matter that Hugo uses to add a title to each page and locate each page in the left navigation menu in <docs.chef.io>. Below is an example of a page's front matter:
```toml
+++
title = "PAGE TITLE"
draft = false
gh_repo = "inspec"
[menu]
[menu.inspec]
title = "PAGE TITLE"
identifier = "inspec/PAGE TITLE"
parent = "inspec"
weight = WEIGHT
+++
```
`title` is the page title.
`gh_repo = "inspec"` adds an "[edit on GitHub]" link to the top of each page that links to the Markdown page in the inspec/inspec repository.
`[menu.inspec]` places the page in the Chef InSpec section of the left navigation menu in <docs.chef.io>. All the parameters following this configure the link in the left navigation menu to the page.
`title` is the title of page in the Chef InSpec menu.
`identifier` is the identifier for a page in the menu. It should formatted like this: `inspec/RESOURCE NAME`. Change `PLATFORM` to the same value as the platform parameter above. Change `RESOURCE NAME` to the name of the resource.
`parent` is the identifier for the section of the menu that the page will be found in. This value is set in the [chef-web-docs menu config](https://github.com/chef/chef-web-docs/blob/main/config/_default/menu.toml). Set this value to the section of the InSpec menu that you want the page to located in.
`weight` sorts the page in the menu relative to other pages. Higher weights are lower in the menu. Pages without a weight are sorted alphabetically by page title.
### Resource Pages
All resource pages are located in `docs-chef-io/content/inspec/resources/`.
#### InSpec Resources Index Page
The InSpec resources index page is located in [`docs-chef-io/content/inspec/resources/_index.md`](content/inspec/resources/_index.md)
and can be found on <https://docs.chef.io/inspec/resources/>.
The resources on this page are organized by platform. All resources in a platform are added to this page using the `inspec_resources` shortcode.
To add a new group of resources of a specific platform, add the shortcode and
specify the platform parameter: `{{< inspec_resources platform="PLATFORM" >}}`
The `inspec_resources` shortcode searches for the `platform` parameter in all pages in the `content/inspec/resources` directory and then creates a list of those pages that have the specified parameter.
#### New Resource Pages
Create a new resource page by running `hugo new -k resource inspec/resources/RESOURCE_NAME.md` from the `docs-chef-io` directory.
This will create a new resource page with enough content preformatted to get you started.
#### Resource Page Front Matter
At the top of each resource is a block of front matter that Hugo uses to add a title to each page and locate each page in the left navigation menu in <docs.chef.io>. Below is an example of a page's front matter:
```toml
+++
title = "RESOURCE NAME resource"
platform = "PLATFORM"
gh_repo = "inspec"
[menu.inspec]
title = "RESOURCE NAME"
identifier = "inspec/resources/PLATFORM/RESOURCE NAME"
parent = "inspec/resources/PLATFORM"
+++
```
`title` is the page title.
`platform = PLATFORM` sorts each page into the correct category in the [Chef InSpec resources list page](https://docs.chef.io/inspec/resources/). Specify the platform that this page should be listed under in the resources list page.
`gh_repo = "inspec"` adds an "[edit on GitHub]" link to the top of each page that links to the Markdown page in the inspec/inspec repository.
`[menu.inspec]` places the page in the Chef InSpec section of the left navigation menu in <docs.chef.io>. All the parameters following this configure the link in the left navigation menu to the page.
`title` is the title of page in the Chef InSpec menu.
`identifier` is the identifier for a page in the menu. It should formatted like this: `inspec/resources/PLATFORM/RESOURCE NAME`. Change `PLATFORM` to the same value as the platform parameter above. Change `RESOURCE NAME` to the name of the resource.
`parent = "inspec/resources/PLATFORM"` is the identifier for the section of the menu that the page will be found in. This value is set in the [chef-web-docs menu config](https://github.com/chef/chef-web-docs/blob/main/config/_default/menu.toml). Change `PLATFORM` to the same value as the platform parameter.
### Shortcodes
A shortcode is a file with a block of text that can be added in multiple places in our documentation by referencing the shortcode file name.
There are two types of shortcodes: Markdown and HTML.
Add a Markdown shortcode to a page by wrapping the filename, without the `.md` file suffix, in double curly braces and percent symbols. For example: `{{% inspec_filter_table %}}`.
Add an HTML shortcode to a page by wrapping the filename, without the `.html` file suffix, in double curly braces and greater than and lesser than symbols. For example: `{{< shortcode_name >}}`.
Some shortcodes take parameters; for example, the `inspec_resources` shortcode requires a platform parameter: `{{< inspec_resources platform="PLATFORM" >}}`
## Local Development Environment
@ -58,7 +151,7 @@ installed and running to build and view our documentation properly.
To install Hugo, NPM, and Go on Windows and macOS:
- On macOS run: `brew install hugo node go`
- On Windows run: `choco install hugo nodejs golang -y`
- On Windows run: `choco install hugo-extended nodejs golang`
To install Hugo on Linux, run:
@ -66,7 +159,7 @@ To install Hugo on Linux, run:
- `snap install node --classic --channel=12`
- `snap install hugo --channel=extended`
## Preview Workstation Documentation
## Preview InSpec Documentation
There are two ways to preview the documentation in `inspec`:
@ -91,73 +184,21 @@ and live reload if any changes are made while the Hugo server is running.
#### Clean Your Local Environment
If you have a local copy of chef-web-docs cloned into `docs-chef-io`,
running `make clean_all` will delete the SASS files, node modules, and fonts in
`docs-chef-io/chef-web-docs/themes/docs-new` used to
build the docs site in the cloned copy of chef-web-docs. Hugo will reinstall these
running `make clean_all` will delete the cloned copy of chef-web-docs. Hugo will rebuild everything from scratch
the next time you run `make serve`.
## Creating New Pages
## Update the InSpec Docs Content on doc.chef.io
Please keep all of the InSpec documentation in the `content/inspec` directory.
To add a new Markdown file, run the following command from the `www` directory:
We use [Hugo modules](https://gohugo.io/hugo-modules/) to build Chef's documentation
from multiple repositories. Expeditor will submit a pull request that updates the documentation
in `chef/chef-web-docs` the next time InSpec is promoted.
```
hugo new content/inspec/<filename>.md
```
The Docs Team can also update the InSpec documentation if changes need to be made
before the next promotion.
If it's a new resource page, run:
```
hugo new -k resource content/inspec/resources/<filename>.md
```
This will create a draft page with enough front matter to get you going. Note that
resource pages must have a platform specified in the page frontmatter. See
the [Resource pages](#resource-pages) section below for more information.
Hugo uses [Goldmark](https://github.com/yuin/goldmark) which is a
superset of Markdown that includes GitHub styled tables, task lists, and
definition lists.
See our [Style Guide](https://docs.chef.io/style_guide/) for more information
about formatting documentation using Markdown.
## Resource Pages
The resource pages are located in `www/content/inspec/resources/`.
The InSpec resources index page is located in `www/content/inspec/resources/_index.md`
and can be found on https://docs.chef.io/inspec/resources/
The resource index page has a shortcode called `inspec_resources` that lists
resource pages by platform. To use the shortcode, add the shortcode and
specify the platform parameter: `{{< inspec_resources platform="<platform>" >}}`
A resource page must be located in `www/content/inspec/resources` and must have
the platform parameter set in its frontmatter. Add `platform = <platform>` to
the page frontmatter to add the platform parameter. For example, the
`aide_conf.md` resource frontmatter has `platform = "linux"` in its page
frontmatter.
### Documentation Content
```
.
├── docs-chef-io
│   ├── content
│   │   ├── inspec # where to keep markdown file documentation
│   │ │ ├── resources # where to keep resource page documentation
| ├── static
| | ├── images
| | | ├── inspec/inspec # where to keep any images you need to reference in your documentation
```
### What is happening behind the scenes
The [Chef Documentation](https://docs.chef.io) site uses [Hugo modules](https://gohugo.io/hugo-modules/)
to load content directly from the `docs-chef-io` directory in the `inspec/inspec`
repository. Every time `inspec/inspec` is promoted to stable, Expeditor
instructs Hugo to update the version of the `inspec/inspec` repository
that Hugo uses to build Chef InSpec documentation on the [Chef Documentation](https://docs.chef.io)
site. This is handled by the Expeditor subscriptions in the `chef/chef-web-docs` GitHub repository.
You can also submit a pull request to chef-web-docs to update the InSpec docs content on docs.chef.io.
See the [chef-web-docs readme](https://github.com/chef/chef-web-docs#update-hugo-modules) for information on updating a
Hugo module in chef-web-docs.
## Documentation Feedback
@ -177,4 +218,3 @@ especially in situations where a doc bug may also surface a product bug.
Submit an issue to [chef-web-docs](https://github.com/chef/chef-web-docs/issues) for
doc feature requests and minor documentation issues.

View file

@ -4,7 +4,7 @@ draft = false
gh_repo = "inspec"
[menu]
[menu.desktop]
[menu.inspec]
title = "{{ replace .Name "-" " " | title }}"
identifier = "inspec/{{ .Name }}.md {{ or (replace .Name "_" " ") (replace .Name "-" " ") | title }}"
parent = "inspec"

View file

@ -1,12 +1,74 @@
+++
title = "{{ or (replace .Name "_" " ") (replace .Name "-" " ") | title }}"
title = "{{ .Name }} resource"
draft = false
platform = "<platform>"
gh_repo = "inspec"
platform = "<PLATFORM>"
[menu]
[menu.desktop]
title = "{{ replace .Name "-" " " | title }}"
identifier = "inspec/resources/{{ .Name }}.md {{ or (replace .Name "_" " ") (replace .Name "-" " ") | title }}"
parent = "inspec/resources"
[menu.inspec]
title = "{{ .Name }}"
identifier = "inspec/resources/<PLATFORM>/{{ .Name }}"
parent = "inspec/resources/<PLATFORM>"
+++
{{/* Run `hugo new -k resource inspec/resources/RESOURCE_NAME.md` to generate a new resource page. */}}
Use the `{{ .Name }}` Chef InSpec audit resource to test the configuration of...
## Installation
{{% inspec/inspec_installation %}}
This resource first became available in Chef InSpec vX.Y.Z.
## Syntax
```ruby
describe {{ .Name }} do
#...
end
```
## Parameters
`PARAMETER`
: PARAMETER DESCRIPTION
`PARAMETER`
: PARAMETER DESCRIPTION
## Properties
`PROPERTY`
: PROPERTY DESCRIPTION
`PROPERTY`
: PROPERTY DESCRIPTION
## Examples
**EXAMPLE DESCRIPTION**
```ruby
describe {{ .Name }} do
#...
end
```
**EXAMPLE DESCRIPTION**
```ruby
describe {{ .Name }} do
#...
end
```
## Matchers
{{% inspec/inspec_matchers_link %}}
**MATCHER_NAME**
The `MATCHER_NAME` matcher tests the value of...
```ruby
its(`MATCHER_NAME`) { should cmp 'VALUE' }
```

View file

@ -45,6 +45,6 @@ InSpec to target applications and services running on AWS and Azure.
### Resources
Chef InSpec has {{% inspec_count_resources %}} [resources](/inspec/resources/) ready to use--from Apache2 to ZFS pool.
Chef InSpec has {{% inspec/inspec_count_resources %}} [resources](/inspec/resources/) ready to use--from Apache2 to ZFS pool.
If you need a solution that we havent provided, you can write your own [custom
resource](/inspec/dsl_resource/).

View file

@ -76,7 +76,7 @@ The `cmp` matcher compares values in the following ways:
end
```
- `cmp` comparisons are not case-sensitive:
- `cmp` comparisons are not case sensitive:
```ruby
describe auditd_conf do
@ -110,7 +110,7 @@ The `cmp` matcher compares values in the following ways:
end
```
- `cmp` allows octal comparisions:
- `cmp` allows octal comparisons:
```ruby
describe file('/proc/cpuinfo') do

View file

@ -13,46 +13,46 @@ gh_repo = "inspec"
The following list of InSpec resources are available.
{{< inspec_resources_filter >}}
{{< inspec/inspec_resources_filter >}}
## OS
{{< inspec_resources platform="os" >}}
{{< inspec/inspec_resources platform="os" >}}
### Linux
The following resources work on Linux operating systems.
{{< inspec_resources platform="linux" >}}
{{< inspec/inspec_resources platform="linux" >}}
### BSD
The following resources work on BSD operating systems.
{{< inspec_resources platform="bsd" >}}
{{< inspec/inspec_resources platform="bsd" >}}
### Windows
The following resources work on Windows operating systems.
{{< inspec_resources platform="windows" >}}
{{< inspec/inspec_resources platform="windows" >}}
## Alibaba
{{< inspec_resources platform="alicloud" >}}
{{< inspec/inspec_resources platform="alicloud" >}}
## AWS
{{< inspec_resources platform="aws" >}}
{{< inspec/inspec_resources platform="aws" >}}
## Azure
{{< inspec_resources platform="azure" >}}
{{< inspec/inspec_resources platform="azure" >}}
## GCP
{{< inspec_resources platform="gcp" >}}
{{< inspec/inspec_resources platform="gcp" >}}
## Habitat
{{< inspec_resources platform="habitat" >}}
{{< inspec/inspec_resources platform="habitat" >}}

View file

@ -17,7 +17,7 @@ Use the `aide_conf` Chef InSpec audit resource to test the rules established for
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `apache_conf` Chef InSpec audit resource to test the configuration setti
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Requirements

View file

@ -17,7 +17,7 @@ Use the `apt` Chef InSpec audit resource to verify Apt repositories on the Debia
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `audit_policy` Chef InSpec audit resource to test auditing policies on t
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `auditd` Chef InSpec audit resource to test the rules for logging that e
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `auditd_conf` Chef InSpec audit resource to test the configuration setti
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use this resource to ensure that a specific data disk attached to a machine has
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -232,9 +232,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -119,8 +119,7 @@ The userTypes property provides a list of all User Types for all users.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_aks_cluster" >}}
{{< inspec/azurerm_deprecated resource="azure_aks_cluster" >}}
Use the `azurerm_aks_cluster` InSpec audit resource to test properties of an Azure AKS Cluster.
@ -119,9 +119,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_aks_clusters" >}}
{{< inspec/azurerm_deprecated resource="azure_aks_clusters" >}}
Use the `azurerm_aks_clusters` InSpec audit resource to enumerate AKS Clusters.
@ -69,9 +69,7 @@ The name of the AKS Cluster
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_cosmosdb_database_account" >}}
{{< inspec/azurerm_deprecated resource="azure_cosmosdb_database_account" >}}
Use the `azurerm_cosmosdb_database_account` InSpec audit resource to test properties and configuration of
an Azure CosmosDb Database Account within a Resource Group.
@ -128,9 +128,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_event_hub_authorization_rule" >}}
{{< inspec/azurerm_deprecated resource="azure_event_hub_authorization_rule" >}}
Use the `azurerm_event_hub_authorization_rule` InSpec audit resource to test properties and configuration of
an Azure Event Hub Authorization Rule within a Resource Group.
@ -113,9 +113,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_event_hub_event_hub" >}}
{{< inspec/azurerm_deprecated resource="azure_event_hub_event_hub" >}}
Use the `azurerm_event_hub_event_hub` InSpec audit resource to test properties and configuration of
an Azure Event Hub Event Hub within a Resource Group.
@ -112,9 +112,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_event_hub_namespace" >}}
{{< inspec/azurerm_deprecated resource="azure_event_hub_namespace" >}}
Use the `azurerm_event_hub_namespace` InSpec audit resource to test properties and configuration of
an Azure Event Hub Namespace within a Resource Group.
@ -127,9 +127,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_iothub" >}}
{{< inspec/azurerm_deprecated resource="azure_iothub" >}}
Use the `azurerm_iothub` InSpec audit resource to test properties and configuration of
an Azure Event Hub Namespace within a Resource Group.
@ -133,9 +133,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_iothub_event_hub_consumer_group" >}}
{{< inspec/azurerm_deprecated resource="azure_iothub_event_hub_consumer_group" >}}
Use the `azurerm_iothub_event_hub_consumer_group` InSpec audit resource to test
properties and configuration of an Azure IoT Hub Event Hub Consumer Group within
@ -119,9 +119,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_iothub_event_hub_consumer_groups" >}}
{{< inspec/azurerm_deprecated resource="azure_iothub_event_hub_consumer_groups" >}}
Use the `azurerm_iothub_event_hub_consumer_groups` InSpec audit resource to test properties and configuration of
an Azure IoT Hub Event Hub Consumer Groups within a Resource Group.
@ -122,9 +122,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_key_vault" >}}
{{< inspec/azurerm_deprecated resource="azure_key_vault" >}}
Use the `azurerm_key_vault` InSpec audit resource to test properties and configuration of
an Azure Key Vault.
@ -122,9 +122,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_key_vault_key" >}}
{{< inspec/azurerm_deprecated resource="azure_key_vault_key" >}}
Use the `azurerm_key_vault_key` InSpec audit resource to test properties and configuration of
an Azure Key within a Vault.
@ -117,9 +117,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_key_vault_keys" >}}
{{< inspec/azurerm_deprecated resource="azure_key_vault_keys" >}}
Use the `azurerm_key_vault_keys` InSpec audit resource to test properties and
configuration of Azure Keys within Vaults.
@ -103,8 +103,7 @@ Resource tags applied to the Key.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_key_vault_secret" >}}
{{< inspec/azurerm_deprecated resource="azure_key_vault_secret" >}}
Use the `azurerm_key_vault_secret` InSpec audit resource to test properties and configuration of
an Azure Secret within a Vault.
@ -130,9 +130,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_key_vault_secrets" >}}
{{< inspec/azurerm_deprecated resource="azure_key_vault_secrets" >}}
Use the `azurerm_key_vault_secrets` InSpec audit resource to test properties and configuration of Azure Secrets within Vaults.
@ -107,8 +107,7 @@ Resource tags applied to the Key.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_key_vaults" >}}
{{< inspec/azurerm_deprecated resource="azure_key_vaults" >}}
Use the `azurerm_key_vaults` InSpec audit resource to test properties and configuration of Azure Key Vaults.
@ -121,8 +121,7 @@ A collection of additional configuration properties related to the Key Vault, e.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_load_balancer" >}}
{{< inspec/azurerm_deprecated resource="azure_load_balancer" >}}
Use the `azurerm_load_balancer` InSpec audit resource to test properties and configuration of
an Azure Load Balancer.
@ -126,9 +126,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_load_balancer" >}}
{{< inspec/azurerm_deprecated resource="azure_load_balancer" >}}
Use the `azurerm_load_balancers` InSpec audit resource to test properties and configuration of Azure Load Balancers.
@ -131,8 +131,7 @@ The type of Resource, typically `Microsoft.Network/loadBalancers`.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_locks" >}}
{{< inspec/azurerm_deprecated resource="azure_locks" >}}
Use the `azurerm_locks` InSpec audit resource to test properties of some or all Azure Resource Locks.
@ -70,8 +70,7 @@ The following examples show how to use this InSpec audit resource.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_management_group" >}}
{{< inspec/azurerm_deprecated resource="azure_management_group" >}}
Use the `azurerm_management_group` InSpec audit resource to test properties related to a
management group.
@ -251,9 +251,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_management_groups" >}}
{{< inspec/azurerm_deprecated resource="azure_management_groups" >}}
Use the `azurerm_management_groups` InSpec audit resource to test properties related to
management groups.

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_monitor_activity_log_alert" >}}
{{< inspec/azurerm_deprecated resource="azure_monitor_activity_log_alert" >}}
Use the `azurerm_monitor_activity_log_alert` InSpec audit resource to test properties
of an Azure Monitor Activity Log Alert.
@ -146,9 +146,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_monitor_activity_log_alerts" >}}
{{< inspec/azurerm_deprecated resource="azure_monitor_activity_log_alerts" >}}
Use the `azurerm_monitor_activity_log_alerts` InSpec audit resource to verify that an
Activity Log Alert exists.
@ -70,9 +70,7 @@ The name of the Activity Log Alert
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_monitor_log_profile" >}}
{{< inspec/azurerm_deprecated resource="azure_monitor_log_profile" >}}
Use the `azurerm_monitor_log_profile` InSpec audit resource to test properties
of an Azure Monitor Log Profile.
@ -108,9 +108,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_monitor_log_profiles" >}}
{{< inspec/azurerm_deprecated resource="azure_monitor_log_profiles" >}}
Use the `azurerm_monitor_log_profiles` InSpec audit resource to verify that a Log Profile
exists.
@ -69,9 +69,7 @@ The name of the Log Profile
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_mysql_database" >}}
{{< inspec/azurerm_deprecated resource="azure_mysql_database" >}}
Use the `azurerm_mysql_database` InSpec audit resource to test properties and configuration of
an Azure MySQL Database on a MySQL Server.
@ -113,9 +113,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_mysql_databases" >}}
{{< inspec/azurerm_deprecated resource="azure_mysql_databases" >}}
Use the `azurerm_mysql_databases` InSpec audit resource to test properties and configuration of Azure MySQL Databases.
@ -111,8 +111,7 @@ A collection of additional configuration properties related to the MySQL Databas
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_mysql_server" >}}
{{< inspec/azurerm_deprecated resource="azure_mysql_server" >}}
Use the `azurerm_mysql_server` InSpec audit resource to test properties and configuration of
an Azure MySQL Server.
@ -126,9 +126,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_mysql_servers" >}}
{{< inspec/azurerm_deprecated resource="azure_mysql_servers" >}}
Use the `azurerm_mysql_servers` InSpec audit resource to test properties and configuration of multiple Azure MySQL Servers.
@ -131,8 +131,7 @@ The type of Resource, typically `Microsoft.DBforMySQL/servers`.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_network_interface" >}}
{{< inspec/azurerm_deprecated resource="azure_network_interface" >}}
Use the `azurerm_network_interface` InSpec audit resource to test properties and configuration of Azure Network Interface.
@ -130,9 +130,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_network_interfaces" >}}
{{< inspec/azurerm_deprecated resource="azure_network_interfaces" >}}
Use the `azurerm_network_interfaces` InSpec audit resource to test properties and configuration of Azure Network interfaces.
@ -127,8 +127,7 @@ The type of Resource, typically `Microsoft.Network/networkInterfaces`.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_network_security_group" >}}
{{< inspec/azurerm_deprecated resource="azure_network_security_group" >}}
Use the `azurerm_network_security_group` InSpec audit resource to test properties of an
Azure Network Security Group.
@ -136,9 +136,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_network_security_groups" >}}
{{< inspec/azurerm_deprecated resource="azure_network_security_groups" >}}
Use the `azurerm_network_security_groups` InSpec audit resource to enumerate Network
Security Groups.
@ -70,9 +70,7 @@ The name of the Network Security Group
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_network_watcher" >}}
{{< inspec/azurerm_deprecated resource="azure_network_watcher" >}}
Use the `azurerm_network_watcher` InSpec audit resource to test properties of an Azure
Network Watcher.
@ -103,9 +103,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_network_watchers" >}}
{{< inspec/azurerm_deprecated resource="azure_network_watchers" >}}
Use the `azurerm_network_watchers` InSpec audit resource to verify that a Network Watcher
exists.
@ -71,9 +71,7 @@ The name of the Network Watcher
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_postgresql_database" >}}
{{< inspec/azurerm_deprecated resource="azure_postgresql_database" >}}
Use the `azurerm_postgresql_database` InSpec audit resource to test properties and configuration of
an Azure PostgreSQL Database on a PostgreSQL Server.
@ -113,9 +113,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_postgresql_databases" >}}
{{< inspec/azurerm_deprecated resource="azure_postgresql_databases" >}}
Use the `azurerm_postgresql_databases` InSpec audit resource to test properties and configuration of Azure PostgreSQL Databases.
@ -103,8 +103,7 @@ A collection of additional configuration properties related to the PostgreSQL Da
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_postgresql_server" >}}
{{< inspec/azurerm_deprecated resource="azure_postgresql_server" >}}
Use the `azurerm_postgresql_server` InSpec audit resource to test properties and configuration of
an Azure PostgreSQL Server.
@ -121,9 +121,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_postgresql_servers" >}}
{{< inspec/azurerm_deprecated resource="azure_postgresql_servers" >}}
Use the `azurerm_postgresql_servers` InSpec audit resource to test properties and configuration of multiple Azure PostgreSQL Servers.
@ -126,8 +126,7 @@ The type of Resource, typically `Microsoft.DBforPostgreSQL/servers`.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_resource_groups" >}}
{{< inspec/azurerm_deprecated resource="azure_resource_groups" >}}
Use the `azurerm_resource_groups` InSpec audit resource to test properties of
some or all Azure Resource Groups
@ -117,9 +117,7 @@ The tags property provides a list of all the Resource Group tags.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_role_definition" >}}
{{< inspec/azurerm_deprecated resource="azure_role_definition" >}}
Use the `azurerm_role_definition` InSpec audit resource to test properties of
an Azure Role Definition.
@ -123,9 +123,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_role_definitions" >}}
{{< inspec/azurerm_deprecated resource="azure_role_definitions" >}}
Use the `azurerm_role_definitions` InSpec audit resource to test properties of
some or all Azure Role Definitions.
@ -108,8 +108,7 @@ Additional properties available for the Roles. May be accessed with dot notation
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_security_center_policies" >}}
{{< inspec/azurerm_deprecated resource="azure_security_center_policies" >}}
Use the `azurerm_security_center_policies` InSpec audit resource to test
properties of some or all Azure Security Center Policies.
@ -88,9 +88,7 @@ name. This is a string value.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_security_center_policy" >}}
{{< inspec/azurerm_deprecated resource="azure_security_center_policy" >}}
Use the `azurerm_security_center_policy` InSpec audit resource to test properties
of the `default` Security Center Policy. Azure currently only supports looking
@ -273,9 +273,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_sql_database" >}}
{{< inspec/azurerm_deprecated resource="azure_sql_database" >}}
Use the `azurerm_sql_database` InSpec audit resource to test properties and configuration of
an Azure SQL Database on a SQL Server.
@ -128,9 +128,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_sql_databases" >}}
{{< inspec/azurerm_deprecated resource="azure_sql_databases" >}}
Use the `azurerm_sql_databases` InSpec audit resource to test properties and configuration of Azure SQL Databases.
@ -128,8 +128,7 @@ A collection of additional configuration properties related to the SQL Database,
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_sql_server" >}}
{{< inspec/azurerm_deprecated resource="azure_sql_server" >}}
Use the `azurerm_sql_server` InSpec audit resource to test properties and configuration of
an Azure SQL Server within a Resource Group.
@ -126,9 +126,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_sql_servers" >}}
{{< inspec/azurerm_deprecated resource="azure_sql_servers" >}}
Use the `azurerm_sql_servers` InSpec audit resource to test properties and configuration of Azure SQL Servers.
@ -131,8 +131,7 @@ The type of Resource, typically `Microsoft.Sql/servers`.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_storage_account_blob_container" >}}
{{< inspec/azurerm_deprecated resource="azure_storage_account_blob_container" >}}
Use the `azurerm_storage_account_blob_container` InSpec audit resource to test properties related to a
Blob Container in an Azure Storage Account.
@ -133,9 +133,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_storage_account_blob_containers" >}}
{{< inspec/azurerm_deprecated resource="azure_storage_account_blob_containers" >}}
Use the `azurerm_storage_account_blob_containers` InSpec audit resource to test properties and configuration of Blob Containers within an Azure Storage Account.
@ -100,8 +100,7 @@ The etag of the Resource, e.g. `\"0x8D592D74CC20EBA\"`.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_subnet" >}}
{{< inspec/azurerm_deprecated resource="azure_subnet" >}}
Use the `azurerm_subnet` InSpec audit resource to test properties related to a
subnet for a given virtual network.
@ -165,9 +165,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_subnet" >}}
{{< inspec/azurerm_deprecated resource="azure_subnet" >}}
Use the `azurerm_subnets` InSpec audit resource to test properties related to
subnets for a resource group.
@ -105,9 +105,7 @@ Gives a list of all the subnet names in the virtual network.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_subscription" >}}
{{< inspec/azurerm_deprecated resource="azure_subscription" >}}
Use the `azurerm_subscription` InSpec audit resource to test properties related to the current subscription
subscription.
@ -89,9 +89,7 @@ An array of locations available in this subscription.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_virtual_machine" >}}
{{< inspec/azurerm_deprecated resource="azure_virtual_machine" >}}
Use the `azurerm_virtual_machine` InSpec audit resource to test properties related to a
virtual machine.
@ -191,9 +191,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_virtual_machine_disk" >}}
{{< inspec/azurerm_deprecated resource="azure_virtual_machine_disk" >}}
Use the `azurerm_virtual_machine_disk` InSpec audit resource to test properties related to
a virtual machine's disk. This resource will only support managed disks. If your disk is
@ -167,9 +167,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_virtual_machine_disks" >}}
{{< inspec/azurerm_deprecated resource="azure_virtual_machine_disks" >}}
Use the `azurerm_virtual_machine_disks` InSpec audit resource to test properties of
some or all Azure Disks within a subscription.
@ -81,8 +81,7 @@ The following examples show how to use this InSpec audit resource.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers,
please visit our [Universal Matchers page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_virtual_machines" >}}
{{< inspec/azurerm_deprecated resource="azure_virtual_machines" >}}
Use the `azurerm_virtual_machines` InSpec audit resource to test properties related to
virtual machines for a resource group.
@ -132,9 +132,7 @@ Gives a list of all the virtual machine names in the resource group.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_virtual_network" >}}
{{< inspec/azurerm_deprecated resource="azure_virtual_network" >}}
Use the `azurerm_virtual_network` InSpec audit resource to test properties related to a
virtual network.
@ -200,9 +200,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_virtual_networks" >}}
{{< inspec/azurerm_deprecated resource="azure_virtual_networks" >}}
Use the `azurerm_virtual_networks` InSpec audit resource to test properties related to
virtual networks for a resource group.
@ -99,9 +99,7 @@ Gives a list of all the virtual network names in the resource group.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_webapp" >}}
{{< inspec/azurerm_deprecated resource="azure_webapp" >}}
Use the `azurerm_webapp` InSpec audit resource to test properties of an Azure Webapp.
@ -130,9 +130,7 @@ requests are always welcome.
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### using_latest?(stack)

View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
{{< azurerm_deprecated resource="azure_webapps" >}}
{{< inspec/azurerm_deprecated resource="azure_webapps" >}}
Use the `azurerm_webapps` InSpec audit resource to enumerate Webapps.
@ -69,9 +69,7 @@ The name of the Webapp
## Matchers
This InSpec audit resource has the following special matchers. For a full list of
available matchers, please visit our [Universal Matchers
page](/inspec/matchers/).
{{% inspec/inspec_matchers_link %}}
### exists

View file

@ -17,7 +17,7 @@ Use the `bash` Chef InSpec audit resource to test an arbitrary command that is r
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `bond` Chef InSpec audit resource to test a logical, bonded network inte
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `bridge` Chef InSpec audit resource to test basic network bridge propert
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `bsd_service` Chef InSpec audit resource to test a service using a Berke
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -15,7 +15,7 @@ Use the `cassandradb_conf` Chef InSpec audit resource to test the configuration
## Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
## Requirements

View file

@ -17,7 +17,7 @@ Use the `cassandradb_session` Chef InSpec audit resource to test Cassandra Query
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
## Syntax

View file

@ -17,7 +17,7 @@ Use the `chocolatey_package` Chef InSpec audit resource to test if the named [Ch
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `chrony_conf` Chef InSpec audit resource to test the synchronization set
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
<!-- TODO: needs version number -->
<!-- ### Version

View file

@ -17,7 +17,7 @@ Use the `command` Chef InSpec audit resource to test an arbitrary command that i
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `cpan` Chef InSpec audit resource to test Perl modules that are installe
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `cran` Chef InSpec audit resource to test R modules that are installed f
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `crontab` Chef InSpec audit resource to test the crontab entries for a p
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `csv` Chef InSpec audit resource to test configuration data in a CSV fil
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `dh_params` Chef InSpec audit resource to test Diffie-Hellman (DH) param
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `directory` Chef InSpec audit resource to test if the file type is a dir
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `docker` Chef InSpec audit resource to test configuration data for the D
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `docker_service` Chef InSpec audit resource to verify a docker swarm ser
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -20,7 +20,7 @@ a variety of settings and statuses.
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `etc_fstab` Chef InSpec audit resource to test information about all par
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `etc_group` Chef InSpec audit resource to test groups that are defined o
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `etc_hosts` Chef InSpec audit resource to test rules set to match IP add
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `etc_hosts_allow` Chef InSpec audit resource to test rules defined for a
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `etc_hosts_deny` Chef InSpec audit resource to test rules for rejecting
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -17,7 +17,7 @@ Use the `filesystem` Chef InSpec resource to audit filesystem disk space usage.
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

View file

@ -19,7 +19,7 @@ A firewalld has a number of zones that can be configured to allow and deny acces
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
{{% inspec/inspec_installation %}}
### Version

Some files were not shown because too many files have changed in this diff Show more