From 77360c123adb911dee07d54b6d4df73e6045dec1 Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Thu, 25 Jan 2024 16:43:48 -0500 Subject: [PATCH 1/2] Revert "Bump Hugo module chef/cookstyle:main to latest stable. (#4229)" (#4232) This reverts commit 1bd618cd12021bf4c9a593990fd9ee7bb4d24271. --- ...hef_correctness_opensslpasswordhelpers.yml | 2 +- .../cops_chef_deprecations_cheffile.yml | 2 +- .../cops_chef_deprecations_delivery.yml | 2 +- .../cops_chef_deprecations_foodcriticfile.yml | 2 +- ...cations_searchusespositionalparameters.yml | 2 +- .../cops_chef_effortless_berksfile.yml | 2 +- .../cops_chef_modernize_definitions.yml | 2 +- ...undantcode_sensitivepropertyinresource.yml | 2 +- .../cops_chef_ruby_gemspeclicense.yml | 14 ------ .../cops_chef_ruby_gemspecrequirerubygems.yml | 11 ----- ...s_chef_ruby_legacypowershelloutmethods.yml | 12 ----- .../cops_chef_ruby_requirenethttps.yml | 19 -------- .../cops_chef_ruby_unlessdefinedrequire.yml | 12 ----- ...cops_chef_style_commentsentencespacing.yml | 2 +- generated/_vendor/modules.txt | 2 +- .../workstation/cookstyle/cops/_index.md | 10 ---- .../cops/chef_ruby_gemspeclicense.md | 43 ----------------- .../cops/chef_ruby_gemspecrequirerubygems.md | 40 ---------------- .../chef_ruby_legacypowershelloutmethods.md | 41 ---------------- .../cops/chef_ruby_requirenethttps.md | 47 ------------------- .../cops/chef_ruby_unlessdefinedrequire.md | 41 ---------------- generated/go.mod | 4 +- generated/go.sum | 8 ++-- 23 files changed, 16 insertions(+), 306 deletions(-) delete mode 100644 generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_gemspeclicense.yml delete mode 100644 generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_gemspecrequirerubygems.yml delete mode 100644 generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_legacypowershelloutmethods.yml delete mode 100644 generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_requirenethttps.yml delete mode 100644 generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_unlessdefinedrequire.yml delete mode 100644 generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspeclicense.md delete mode 100644 generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspecrequirerubygems.md delete mode 100644 generated/generated_content/workstation/cookstyle/cops/chef_ruby_legacypowershelloutmethods.md delete mode 100644 generated/generated_content/workstation/cookstyle/cops/chef_ruby_requirenethttps.md delete mode 100644 generated/generated_content/workstation/cookstyle/cops/chef_ruby_unlessdefinedrequire.md diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_correctness_opensslpasswordhelpers.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_correctness_opensslpasswordhelpers.yml index f30c542e3a..01bbde7e60 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_correctness_opensslpasswordhelpers.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_correctness_opensslpasswordhelpers.yml @@ -10,7 +10,7 @@ description: |- basic_auth_password = secure_password autocorrection: false target_chef_version: All Versions -examples: +examples: version_added: 6.6.0 enabled: true excluded_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_cheffile.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_cheffile.yml index 4cc440d474..9fd44cf2b0 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_cheffile.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_cheffile.yml @@ -8,7 +8,7 @@ description: The Librarian-Chef depsolving project is no longer maintained and a offers a more similar, and still supported, experience to Librarian-Chef. autocorrection: false target_chef_version: All Versions -examples: +examples: version_added: 5.12.0 enabled: true included_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_delivery.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_delivery.yml index ab7a22740a..84c0b75d73 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_delivery.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_delivery.yml @@ -9,7 +9,7 @@ description: |- or Delivery cookbooks. The contents of this directory are now obsolete and should be removed. autocorrection: false target_chef_version: All Versions -examples: +examples: version_added: 7.31.0 enabled: true included_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_foodcriticfile.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_foodcriticfile.yml index 1669dc1715..7dfbf83d9e 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_foodcriticfile.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_foodcriticfile.yml @@ -7,7 +7,7 @@ description: The Foodcritic cookbook linter has been deprecated and should no lo by Foodcritic in your cookbooks. autocorrection: false target_chef_version: All Versions -examples: +examples: version_added: 7.32.0 enabled: true included_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_searchusespositionalparameters.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_searchusespositionalparameters.yml index a6483b1661..f5fb6f09e0 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_searchusespositionalparameters.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_searchusespositionalparameters.yml @@ -11,7 +11,7 @@ description: |- search(:node, '*:*', start: 0) autocorrection: true target_chef_version: All Versions -examples: +examples: version_added: 5.11.0 enabled: true excluded_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_effortless_berksfile.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_effortless_berksfile.yml index 548e1b595b..b154c95fd6 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_effortless_berksfile.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_effortless_berksfile.yml @@ -6,7 +6,7 @@ description: Policyfiles should be used for cookbook dependency solving instead a Berkshelf Berksfile. autocorrection: false target_chef_version: All Versions -examples: +examples: version_added: 5.12.0 enabled: false included_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_modernize_definitions.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_modernize_definitions.yml index b48a80d496..2a76d7e225 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_modernize_definitions.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_modernize_definitions.yml @@ -9,7 +9,7 @@ description: In 2016 with Chef Infra Client 12.5 Custom Resources were introduce resource reporting. autocorrection: false target_chef_version: All Versions -examples: +examples: version_added: 5.11.0 enabled: true included_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_redundantcode_sensitivepropertyinresource.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_redundantcode_sensitivepropertyinresource.yml index b61f14aa86..8303c7919a 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_redundantcode_sensitivepropertyinresource.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_redundantcode_sensitivepropertyinresource.yml @@ -9,7 +9,7 @@ description: |- property :sensitive, [true, false], default: false autocorrection: true target_chef_version: All Versions -examples: +examples: version_added: 5.16.0 enabled: true included_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_gemspeclicense.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_gemspeclicense.yml deleted file mode 100644 index 413de2683f..0000000000 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_gemspeclicense.yml +++ /dev/null @@ -1,14 +0,0 @@ ---- -short_name: GemspecLicense -full_name: Chef/Ruby/GemspecLicense -department: Chef/Ruby -description: All gemspec files should define their license. -autocorrection: false -target_chef_version: All Versions -examples: |2- - - # good - spec.license = "Apache-2.0" - ``` -version_added: -enabled: false diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_gemspecrequirerubygems.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_gemspecrequirerubygems.yml deleted file mode 100644 index 02a65dfa91..0000000000 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_gemspecrequirerubygems.yml +++ /dev/null @@ -1,11 +0,0 @@ ---- -short_name: GemspecRequireRubygems -full_name: Chef/Ruby/GemspecRequireRubygems -department: Chef/Ruby -description: Rubygems does not need to be required in a Gemspec. It's already loaded - out of the box in Ruby now. -autocorrection: true -target_chef_version: All Versions -examples: -version_added: -enabled: false diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_legacypowershelloutmethods.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_legacypowershelloutmethods.yml deleted file mode 100644 index 5670632813..0000000000 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_legacypowershelloutmethods.yml +++ /dev/null @@ -1,12 +0,0 @@ ---- -short_name: LegacyPowershellOutMethods -full_name: Chef/Ruby/LegacyPowershellOutMethods -department: Chef/Ruby -description: |- - Use powershell_exec!/powershell_exec instead of powershell_out!/powershell_out. The new - methods don't spawn 2 shells per shellout and instead use .NET bindings to call PS directly. -autocorrection: false -target_chef_version: All Versions -examples: -version_added: -enabled: false diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_requirenethttps.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_requirenethttps.yml deleted file mode 100644 index 41238c40d2..0000000000 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_requirenethttps.yml +++ /dev/null @@ -1,19 +0,0 @@ ---- -short_name: RequireNetHttps -full_name: Chef/Ruby/RequireNetHttps -department: Chef/Ruby -description: net/https is deprecated and just includes net/http and openssl. We should - include those directly instead. -autocorrection: true -target_chef_version: All Versions -examples: |2- - - # bad - require 'net/https' - - # good - require 'net/http' - require 'openssl' - ``` -version_added: -enabled: false diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_unlessdefinedrequire.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_unlessdefinedrequire.yml deleted file mode 100644 index a0427721b7..0000000000 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_unlessdefinedrequire.yml +++ /dev/null @@ -1,12 +0,0 @@ ---- -short_name: UnlessDefinedRequire -full_name: Chef/Ruby/UnlessDefinedRequire -department: Chef/Ruby -description: |- - Rubygems is VERY slow to require gems even if they've already been loaded. To work around this - wrap your require statement with an `if defined?()` check. -autocorrection: true -target_chef_version: All Versions -examples: -version_added: -enabled: false diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_style_commentsentencespacing.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_style_commentsentencespacing.yml index 8c24516237..9b7d6b1bb1 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_style_commentsentencespacing.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_style_commentsentencespacing.yml @@ -7,6 +7,6 @@ description: |- Note: This is DISABLED by default. autocorrection: true target_chef_version: All Versions -examples: +examples: version_added: 5.1.0 enabled: false diff --git a/generated/_vendor/modules.txt b/generated/_vendor/modules.txt index 8e17f3f537..f724d229ca 100644 --- a/generated/_vendor/modules.txt +++ b/generated/_vendor/modules.txt @@ -1 +1 @@ -# github.com/chef/cookstyle/docs-chef-io v0.0.0-20240123213114-ace8dd00994a +# github.com/chef/cookstyle/docs-chef-io v0.0.0-20230825054940-2971520aef80 diff --git a/generated/generated_content/workstation/cookstyle/cops/_index.md b/generated/generated_content/workstation/cookstyle/cops/_index.md index 0b69f9aa40..7d503fea54 100644 --- a/generated/generated_content/workstation/cookstyle/cops/_index.md +++ b/generated/generated_content/workstation/cookstyle/cops/_index.md @@ -264,16 +264,6 @@ These cops detect redundant cookbook code. - [UnnecessaryNameProperty](/workstation/cookstyle/cops/chef_redundantcode_unnecessarynameproperty) - [UseCreateIfMissing](/workstation/cookstyle/cops/chef_redundantcode_usecreateifmissing) -## Chef/Ruby - - - -- [GemspecLicense](/workstation/cookstyle/cops/chef_ruby_gemspeclicense) -- [GemspecRequireRubygems](/workstation/cookstyle/cops/chef_ruby_gemspecrequirerubygems) -- [LegacyPowershellOutMethods](/workstation/cookstyle/cops/chef_ruby_legacypowershelloutmethods) -- [RequireNetHttps](/workstation/cookstyle/cops/chef_ruby_requirenethttps) -- [UnlessDefinedRequire](/workstation/cookstyle/cops/chef_ruby_unlessdefinedrequire) - ## Chef/Security These cops detect potential security issues in your cookbook code. diff --git a/generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspeclicense.md b/generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspeclicense.md deleted file mode 100644 index edc57bea87..0000000000 --- a/generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspeclicense.md +++ /dev/null @@ -1,43 +0,0 @@ -+++ -title = "Chef/Ruby/GemspecLicense" -aliases = ["/workstation/cookstyle/chef_ruby_gemspeclicense/"] - -+++ - - - -[Cookstyle cops page](/workstation/cookstyle/cops/) - -The Cookstyle cops department: `Chef/Ruby` - -| Enabled by default | Supports autocorrection | Target Chef Version | -| --- | --- | --- | -| Not Enabled | No | All Versions | - -All gemspec files should define their license. - -## Examples - -# good -spec.license = "Apache-2.0" -``` - -## Configurable attributes - - - - - - - - - - - - - - - -
NameDefault valueConfigurable values
Version AddedString
Include
    -
-		Array
diff --git a/generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspecrequirerubygems.md b/generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspecrequirerubygems.md deleted file mode 100644 index 595b70d1e3..0000000000 --- a/generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspecrequirerubygems.md +++ /dev/null @@ -1,40 +0,0 @@ -+++ -title = "Chef/Ruby/GemspecRequireRubygems" -aliases = ["/workstation/cookstyle/chef_ruby_gemspecrequirerubygems/"] - -+++ - - - -[Cookstyle cops page](/workstation/cookstyle/cops/) - -The Cookstyle cops department: `Chef/Ruby` - -| Enabled by default | Supports autocorrection | Target Chef Version | -| --- | --- | --- | -| Not Enabled | Yes | All Versions | - -Rubygems does not need to be required in a Gemspec. It's already loaded out of the box in Ruby now. - -## Examples - - -## Configurable attributes - - - - - - - - - - - - - - - -
NameDefault valueConfigurable values
Version AddedString
Include
    -
-		Array
diff --git a/generated/generated_content/workstation/cookstyle/cops/chef_ruby_legacypowershelloutmethods.md b/generated/generated_content/workstation/cookstyle/cops/chef_ruby_legacypowershelloutmethods.md deleted file mode 100644 index d5007611fe..0000000000 --- a/generated/generated_content/workstation/cookstyle/cops/chef_ruby_legacypowershelloutmethods.md +++ /dev/null @@ -1,41 +0,0 @@ -+++ -title = "Chef/Ruby/LegacyPowershellOutMethods" -aliases = ["/workstation/cookstyle/chef_ruby_legacypowershelloutmethods/"] - -+++ - - - -[Cookstyle cops page](/workstation/cookstyle/cops/) - -The Cookstyle cops department: `Chef/Ruby` - -| Enabled by default | Supports autocorrection | Target Chef Version | -| --- | --- | --- | -| Not Enabled | No | All Versions | - -Use powershell_exec!/powershell_exec instead of powershell_out!/powershell_out. The new -methods don't spawn 2 shells per shellout and instead use .NET bindings to call PS directly. - -## Examples - - -## Configurable attributes - - - - - - - - - - - - - - - -
NameDefault valueConfigurable values
Version AddedString
Include
    -
-		Array
diff --git a/generated/generated_content/workstation/cookstyle/cops/chef_ruby_requirenethttps.md b/generated/generated_content/workstation/cookstyle/cops/chef_ruby_requirenethttps.md deleted file mode 100644 index 9e03dd6545..0000000000 --- a/generated/generated_content/workstation/cookstyle/cops/chef_ruby_requirenethttps.md +++ /dev/null @@ -1,47 +0,0 @@ -+++ -title = "Chef/Ruby/RequireNetHttps" -aliases = ["/workstation/cookstyle/chef_ruby_requirenethttps/"] - -+++ - - - -[Cookstyle cops page](/workstation/cookstyle/cops/) - -The Cookstyle cops department: `Chef/Ruby` - -| Enabled by default | Supports autocorrection | Target Chef Version | -| --- | --- | --- | -| Not Enabled | Yes | All Versions | - -net/https is deprecated and just includes net/http and openssl. We should include those directly instead. - -## Examples - -# bad -require 'net/https' - -# good -require 'net/http' -require 'openssl' -``` - -## Configurable attributes - - - - - - - - - - - - - - - -
NameDefault valueConfigurable values
Version AddedString
Include
    -
-		Array
diff --git a/generated/generated_content/workstation/cookstyle/cops/chef_ruby_unlessdefinedrequire.md b/generated/generated_content/workstation/cookstyle/cops/chef_ruby_unlessdefinedrequire.md deleted file mode 100644 index 9f51d85b76..0000000000 --- a/generated/generated_content/workstation/cookstyle/cops/chef_ruby_unlessdefinedrequire.md +++ /dev/null @@ -1,41 +0,0 @@ -+++ -title = "Chef/Ruby/UnlessDefinedRequire" -aliases = ["/workstation/cookstyle/chef_ruby_unlessdefinedrequire/"] - -+++ - - - -[Cookstyle cops page](/workstation/cookstyle/cops/) - -The Cookstyle cops department: `Chef/Ruby` - -| Enabled by default | Supports autocorrection | Target Chef Version | -| --- | --- | --- | -| Not Enabled | Yes | All Versions | - -Rubygems is VERY slow to require gems even if they've already been loaded. To work around this -wrap your require statement with an `if defined?()` check. - -## Examples - - -## Configurable attributes - - - - - - - - - - - - - - - -
NameDefault valueConfigurable values
Version AddedString
Include
    -
-		Array
diff --git a/generated/go.mod b/generated/go.mod index ef8aff1d39..ace29d8f3b 100644 --- a/generated/go.mod +++ b/generated/go.mod @@ -3,6 +3,6 @@ module github.com/chef/chef-web-docs/generated go 1.17 require ( - github.com/chef/cookstyle v7.32.7+incompatible // indirect - github.com/chef/cookstyle/docs-chef-io v0.0.0-20240123213114-ace8dd00994a // indirect + github.com/chef/cookstyle v7.32.3+incompatible // indirect + github.com/chef/cookstyle/docs-chef-io v0.0.0-20230825054940-2971520aef80 // indirect ) diff --git a/generated/go.sum b/generated/go.sum index 9406f1df93..1fe377ebed 100644 --- a/generated/go.sum +++ b/generated/go.sum @@ -1,4 +1,4 @@ -github.com/chef/cookstyle v7.32.7+incompatible h1:xuM38xNnGIjZEkDFSpoJMnB3A7d0mhiy6IA4fJbbSno= -github.com/chef/cookstyle v7.32.7+incompatible/go.mod h1:KUadmsdBr7Hpo5dtGVQMiwb8KlC91W3j1lfc0yuVwtw= -github.com/chef/cookstyle/docs-chef-io v0.0.0-20240123213114-ace8dd00994a h1:Wctokx9S/SZdDa6sY5XZkE5LZ9cXPrjctiUrKLNvsSQ= -github.com/chef/cookstyle/docs-chef-io v0.0.0-20240123213114-ace8dd00994a/go.mod h1:1JOEECsW9ozt1/RmprJjAQEvCrOHobpWepSQJRQOhnY= +github.com/chef/cookstyle v7.32.3+incompatible h1:7ZJ3ZdAOAnElLm2nI3FycomDGAZLXXghCX2AsFpd6s8= +github.com/chef/cookstyle v7.32.3+incompatible/go.mod h1:KUadmsdBr7Hpo5dtGVQMiwb8KlC91W3j1lfc0yuVwtw= +github.com/chef/cookstyle/docs-chef-io v0.0.0-20230825054940-2971520aef80 h1:qR1b+TF26odPlERq2C75CrFcIFmJ9TJCjGEs2fUT/0c= +github.com/chef/cookstyle/docs-chef-io v0.0.0-20230825054940-2971520aef80/go.mod h1:1JOEECsW9ozt1/RmprJjAQEvCrOHobpWepSQJRQOhnY= From bfa3ded64640ddf70c8aeccbbedaad2d8d9d9abb Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Mon, 29 Jan 2024 12:25:38 -0500 Subject: [PATCH 2/2] WIP (#4233) Signed-off-by: Ian Maddaus --- .../alicloud_apsaradb_rds_instance.md | 2 +- .../alicloud_apsaradb_rds_instances.md | 4 +- .../content/inspec/resources/alicloud_disk.md | 8 +- .../inspec/resources/alicloud_disks.md | 8 +- .../inspec/resources/alicloud_ecs_instance.md | 6 +- .../resources/alicloud_ecs_instances.md | 6 +- .../inspec/resources/alicloud_ims_user.md | 112 ++++++++ .../inspec/resources/alicloud_ram_policies.md | 4 +- .../inspec/resources/alicloud_ram_policy.md | 6 +- .../inspec/resources/alicloud_ram_user.md | 6 +- .../inspec/resources/alicloud_ram_user_mfa.md | 8 +- .../inspec/resources/alicloud_ram_users.md | 4 +- .../inspec/resources/reusable/index.md | 5 + .../md}/alibaba_access_management_doc.md | 0 .../md}/alibaba_authentication_ecs_api_doc.md | 0 .../md}/alibaba_authentication_ram_api_doc.md | 0 .../alicloud_principal_action.md | 0 .../content/inspec/resources/aws_alb.md | 10 +- .../content/inspec/resources/aws_albs.md | 10 +- .../content/inspec/resources/aws_ami.md | 10 +- .../content/inspec/resources/aws_amis.md | 10 +- .../inspec/resources/aws_amplify_app.md | 10 +- .../inspec/resources/aws_amplify_apps.md | 8 +- .../inspec/resources/aws_amplify_branch.md | 10 +- .../inspec/resources/aws_amplify_branches.md | 8 +- .../resources/aws_api_gateway_deployment.md | 10 +- .../resources/aws_api_gateway_deployments.md | 10 +- .../aws_api_gateway_documentation_part.md | 10 +- .../aws_api_gateway_documentation_parts.md | 10 +- .../aws_api_gateway_documentation_version.md | 10 +- .../aws_api_gateway_documentation_versions.md | 10 +- .../resources/aws_api_gateway_domain_name.md | 190 +++++++++++++ .../resources/aws_api_gateway_domain_names.md | 174 ++++++++++++ .../resources/aws_api_gateway_method.md | 10 +- .../resources/aws_api_gateway_methods.md | 10 +- .../inspec/resources/aws_api_gateway_model.md | 10 +- .../resources/aws_api_gateway_models.md | 10 +- .../aws_api_gateway_request_validator.md | 101 +++++++ .../aws_api_gateway_request_validators.md | 115 ++++++++ .../resources/aws_api_gateway_resource.md | 120 ++++++++ .../resources/aws_api_gateway_resources.md | 116 ++++++++ .../resources/aws_api_gateway_response.md | 10 +- .../resources/aws_api_gateway_responses.md | 10 +- .../resources/aws_api_gateway_restapi.md | 10 +- .../resources/aws_api_gateway_restapis.md | 10 +- .../inspec/resources/aws_api_gateway_stage.md | 10 +- .../resources/aws_api_gateway_stages.md | 10 +- .../resources/aws_api_gateway_usage_plan.md | 170 +++++++++++ .../aws_api_gateway_usage_plan_key.md | 99 +++++++ .../aws_api_gateway_usage_plan_keys.md | 103 +++++++ .../resources/aws_api_gateway_usage_plans.md | 121 ++++++++ .../resources/aws_api_gateway_v2_api.md | 156 ++++++++++ .../aws_api_gateway_v2_api_mapping.md | 113 ++++++++ .../aws_api_gateway_v2_api_mappings.md | 118 ++++++++ .../resources/aws_api_gateway_v2_apis.md | 169 +++++++++++ .../aws_api_gateway_v2_authorizer.md | 150 ++++++++++ .../aws_api_gateway_v2_authorizers.md | 171 +++++++++++ .../aws_api_gateway_v2_deployment.md | 129 +++++++++ .../aws_api_gateway_v2_deployments.md | 139 +++++++++ .../aws_api_gateway_v2_domain_name.md | 164 +++++++++++ .../aws_api_gateway_v2_domain_names.md | 113 ++++++++ .../aws_api_gateway_v2_integration.md | 182 ++++++++++++ ...aws_api_gateway_v2_integration_response.md | 121 ++++++++ ...ws_api_gateway_v2_integration_responses.md | 130 +++++++++ .../aws_api_gateway_v2_integrations.md | 219 ++++++++++++++ .../resources/aws_api_gateway_v2_model.md | 118 ++++++++ .../resources/aws_api_gateway_v2_models.md | 125 ++++++++ .../resources/aws_api_gateway_v2_route.md | 158 +++++++++++ .../resources/aws_api_gateway_v2_routes.md | 165 +++++++++++ .../resources/aws_api_gateway_vpc_link.md | 112 ++++++++ .../resources/aws_api_gateway_vpc_links.md | 124 ++++++++ .../resources/aws_apigateway_account.md | 10 +- .../resources/aws_apigateway_api_key.md | 10 +- .../resources/aws_apigateway_api_keys.md | 10 +- .../resources/aws_apigateway_authorizer.md | 10 +- .../resources/aws_apigateway_authorizers.md | 10 +- .../aws_apigateway_base_path_mapping.md | 10 +- .../aws_apigateway_base_path_mappings.md | 10 +- .../aws_apigateway_client_certificate.md | 10 +- .../aws_apigateway_client_certificates.md | 10 +- ...application_autoscaling_scalable_target.md | 8 +- ...pplication_autoscaling_scalable_targets.md | 8 +- ...pplication_autoscaling_scaling_policies.md | 8 +- ..._application_autoscaling_scaling_policy.md | 8 +- .../inspec/resources/aws_athena_work_group.md | 8 +- .../resources/aws_athena_work_groups.md | 8 +- .../resources/aws_auto_scaling_group.md | 10 +- .../resources/aws_auto_scaling_groups.md | 8 +- .../aws_autoscaling_scaling_policies.md | 8 +- .../aws_autoscaling_scaling_policy.md | 8 +- .../aws_batch_compute_environment.md | 8 +- .../aws_batch_compute_environments.md | 6 +- .../resources/aws_batch_job_definition.md | 8 +- .../resources/aws_batch_job_definitions.md | 6 +- .../inspec/resources/aws_batch_job_queue.md | 8 +- .../inspec/resources/aws_batch_job_queues.md | 8 +- .../aws_cloud_formation_stack_set.md | 8 +- .../aws_cloud_formation_stack_sets.md | 8 +- .../resources/aws_cloudformation_stack.md | 10 +- .../resources/aws_cloudformation_stacks.md | 10 +- .../resources/aws_cloudformation_template.md | 10 +- .../aws_cloudfront_cache_policies.md | 8 +- .../resources/aws_cloudfront_cache_policy.md | 10 +- .../resources/aws_cloudfront_distribution.md | 10 +- .../resources/aws_cloudfront_distributions.md | 10 +- .../resources/aws_cloudfront_key_group.md | 10 +- .../resources/aws_cloudfront_key_groups.md | 8 +- ...aws_cloudfront_origin_access_identities.md | 8 +- .../aws_cloudfront_origin_access_identity.md | 10 +- .../aws_cloudfront_origin_request_policy.md | 10 +- .../resources/aws_cloudfront_public_key.md | 10 +- .../resources/aws_cloudfront_public_keys.md | 8 +- .../aws_cloudfront_realtime_log_config.md | 10 +- .../aws_cloudfront_realtime_log_configs.md | 8 +- .../aws_cloudfront_streaming_distribution.md | 10 +- .../aws_cloudfront_streaming_distributions.md | 8 +- .../inspec/resources/aws_cloudtrail_trail.md | 106 ++++--- .../inspec/resources/aws_cloudtrail_trails.md | 10 +- .../inspec/resources/aws_cloudwatch_alarm.md | 10 +- .../aws_cloudwatch_anomaly_detector.md | 8 +- .../aws_cloudwatch_anomaly_detectors.md | 8 +- .../aws_cloudwatch_composite_alarm.md | 8 +- .../aws_cloudwatch_composite_alarms.md | 8 +- .../resources/aws_cloudwatch_dashboard.md | 10 +- .../resources/aws_cloudwatch_dashboards.md | 8 +- .../resources/aws_cloudwatch_insight_rules.md | 8 +- .../resources/aws_cloudwatch_log_group.md | 9 +- .../aws_cloudwatch_log_metric_filter.md | 10 +- .../resources/aws_cloudwatch_metric_stream.md | 10 +- .../aws_cloudwatch_metric_streams.md | 8 +- .../aws_cloudwatchlogs_destination.md | 8 +- .../aws_cloudwatchlogs_destinations.md | 8 +- .../aws_cloudwatchlogs_log_stream.md | 8 +- .../aws_cloudwatchlogs_log_streams.md | 8 +- .../aws_cloudwatchlogs_subscription_filter.md | 8 +- ...aws_cloudwatchlogs_subscription_filters.md | 8 +- .../resources/aws_cognito_identity_pool.md | 8 +- .../resources/aws_cognito_identity_pools.md | 8 +- .../inspec/resources/aws_cognito_userpool.md | 8 +- .../resources/aws_cognito_userpool_client.md | 8 +- .../resources/aws_cognito_userpool_clients.md | 8 +- .../inspec/resources/aws_cognito_userpools.md | 8 +- .../resources/aws_config_delivery_channel.md | 6 +- .../inspec/resources/aws_config_recorder.md | 6 +- .../resources/aws_db_parameter_group.md | 10 +- .../resources/aws_db_parameter_groups.md | 10 +- .../inspec/resources/aws_db_subnet_group.md | 12 +- .../inspec/resources/aws_db_subnet_groups.md | 10 +- .../inspec/resources/aws_dhcp_options.md | 6 +- .../inspec/resources/aws_dms_endpoint.md | 8 +- .../inspec/resources/aws_dms_endpoints.md | 8 +- .../resources/aws_dms_replication_instance.md | 8 +- .../aws_dms_replication_instances.md | 8 +- .../aws_dms_replication_subnet_group.md | 8 +- .../aws_dms_replication_subnet_groups.md | 8 +- .../inspec/resources/aws_dynamodb_table.md | 10 +- .../inspec/resources/aws_dynamodb_tables.md | 10 +- .../inspec/resources/aws_ebs_snapshot.md | 8 +- .../inspec/resources/aws_ebs_snapshots.md | 10 +- .../inspec/resources/aws_ebs_volume.md | 10 +- .../inspec/resources/aws_ebs_volumes.md | 10 +- .../resources/aws_ec2_capacity_reservation.md | 8 +- .../aws_ec2_capacity_reservations.md | 8 +- .../resources/aws_ec2_carrier_gateway.md | 8 +- .../resources/aws_ec2_carrier_gateways.md | 8 +- .../aws_ec2_client_vpn_authorization_rule.md | 8 +- .../aws_ec2_client_vpn_authorization_rules.md | 8 +- .../resources/aws_ec2_client_vpn_endpoint.md | 8 +- .../resources/aws_ec2_client_vpn_endpoints.md | 8 +- .../resources/aws_ec2_client_vpn_route.md | 8 +- .../resources/aws_ec2_client_vpn_routes.md | 8 +- ...2_client_vpn_target_network_association.md | 8 +- ..._client_vpn_target_network_associations.md | 8 +- .../resources/aws_ec2_customer_gateway.md | 8 +- .../resources/aws_ec2_customer_gateways.md | 8 +- .../inspec/resources/aws_ec2_dhcp_option.md | 6 +- .../inspec/resources/aws_ec2_dhcp_options.md | 6 +- .../aws_ec2_egress_only_internet_gateway.md | 8 +- .../aws_ec2_egress_only_internet_gateways.md | 8 +- .../content/inspec/resources/aws_ec2_eip.md | 8 +- .../resources/aws_ec2_eip_association.md | 8 +- .../resources/aws_ec2_eip_associations.md | 10 +- .../content/inspec/resources/aws_ec2_eips.md | 10 +- .../content/inspec/resources/aws_ec2_fleet.md | 8 +- .../inspec/resources/aws_ec2_fleets.md | 8 +- .../content/inspec/resources/aws_ec2_host.md | 8 +- .../content/inspec/resources/aws_ec2_hosts.md | 8 +- .../inspec/resources/aws_ec2_instance.md | 9 +- .../inspec/resources/aws_ec2_instances.md | 8 +- .../resources/aws_ec2_internet_gateway.md | 8 +- .../resources/aws_ec2_internet_gateways.md | 8 +- .../resources/aws_ec2_launch_template.md | 4 +- .../resources/aws_ec2_launch_templates.md | 6 +- .../aws_ec2_network_insights_analysis.md | 8 +- ...ws_ec2_network_insights_analysis_plural.md | 8 +- .../aws_ec2_network_insights_path.md | 8 +- .../aws_ec2_network_insights_paths.md | 8 +- .../resources/aws_ec2_network_interface.md | 8 +- .../aws_ec2_network_interface_attachment.md | 8 +- .../aws_ec2_network_interface_attachments.md | 8 +- .../aws_ec2_network_interface_permission.md | 8 +- .../aws_ec2_network_interface_permissions.md | 8 +- .../resources/aws_ec2_network_interfaces.md | 8 +- .../resources/aws_ec2_placement_group.md | 8 +- .../resources/aws_ec2_placement_groups.md | 8 +- .../inspec/resources/aws_ec2_prefix_list.md | 8 +- .../inspec/resources/aws_ec2_prefix_lists.md | 8 +- .../inspec/resources/aws_ec2_spot_fleet.md | 8 +- .../inspec/resources/aws_ec2_spot_fleets.md | 8 +- .../aws_ec2_traffic_mirror_filter.md | 8 +- .../aws_ec2_traffic_mirror_filters.md | 8 +- .../aws_ec2_traffic_mirror_session.md | 10 +- .../aws_ec2_traffic_mirror_sessions.md | 10 +- .../aws_ec2_transit_gateway_attachment.md | 8 +- .../aws_ec2_transit_gateway_attachments.md | 10 +- .../aws_ec2_transit_gateway_route_table.md | 8 +- ...transit_gateway_route_table_association.md | 6 +- ...ransit_gateway_route_table_associations.md | 6 +- ...transit_gateway_route_table_propagation.md | 10 +- ...ransit_gateway_route_table_propagations.md | 10 +- .../aws_ec2_transit_gateway_route_tables.md | 10 +- .../resources/aws_ec2_volume_attachment.md | 8 +- .../resources/aws_ec2_volume_attachments.md | 8 +- .../aws_ec2_vpc_peering_connection.md | 8 +- .../aws_ec2_vpc_peering_connections.md | 8 +- .../aws_ec2_vpn_connection_routes.md | 8 +- .../aws_ec2_vpn_gateway_route_propagation.md | 8 +- .../aws_ec2_vpn_gateway_route_propagations.md | 8 +- .../content/inspec/resources/aws_ecr.md | 7 +- .../content/inspec/resources/aws_ecr_image.md | 7 +- .../inspec/resources/aws_ecr_images.md | 9 +- .../inspec/resources/aws_ecr_repositories.md | 8 +- .../inspec/resources/aws_ecr_repository.md | 9 +- .../resources/aws_ecr_repository_policy.md | 6 +- .../resources/aws_ecrpublic_repositories.md | 10 +- .../resources/aws_ecrpublic_repository.md | 8 +- .../inspec/resources/aws_ecs_cluster.md | 10 +- .../inspec/resources/aws_ecs_clusters.md | 6 +- .../inspec/resources/aws_ecs_service.md | 8 +- .../inspec/resources/aws_ecs_services.md | 8 +- .../resources/aws_ecs_task_definition.md | 8 +- .../resources/aws_ecs_task_definitions.md | 8 +- .../inspec/resources/aws_efs_file_system.md | 9 +- .../inspec/resources/aws_efs_file_systems.md | 8 +- .../inspec/resources/aws_efs_mount_target.md | 8 +- .../inspec/resources/aws_efs_mount_targets.md | 8 +- .../inspec/resources/aws_eks_cluster.md | 10 +- .../inspec/resources/aws_eks_clusters.md | 10 +- .../resources/aws_elasticache_cluster.md | 9 +- .../resources/aws_elasticache_cluster_node.md | 9 +- .../resources/aws_elasticache_clusters.md | 8 +- .../aws_elasticache_replication_group.md | 10 +- .../aws_elasticache_replication_groups.md | 10 +- .../aws_elasticloadbalancingv2_listener.md | 10 +- ...ticloadbalancingv2_listener_certificate.md | 10 +- ...icloadbalancingv2_listener_certificates.md | 8 +- ...ws_elasticloadbalancingv2_listener_rule.md | 8 +- ...s_elasticloadbalancingv2_listener_rules.md | 8 +- .../aws_elasticloadbalancingv2_listeners.md | 8 +- ...aws_elasticloadbalancingv2_target_group.md | 8 +- ...ws_elasticloadbalancingv2_target_groups.md | 8 +- .../aws_elasticsearchservice_domain.md | 8 +- .../aws_elasticsearchservice_domains.md | 8 +- .../content/inspec/resources/aws_elb.md | 10 +- .../content/inspec/resources/aws_elbs.md | 8 +- .../inspec/resources/aws_emr_cluster.md | 10 +- .../inspec/resources/aws_emr_clusters.md | 6 +- .../aws_emr_security_configuration.md | 10 +- .../aws_emr_security_configurations.md | 8 +- .../inspec/resources/aws_eventbridge_rule.md | 8 +- .../inspec/resources/aws_eventbridge_rules.md | 8 +- .../content/inspec/resources/aws_flow_log.md | 8 +- .../inspec/resources/aws_glue_crawler.md | 10 +- .../inspec/resources/aws_glue_crawlers.md | 10 +- .../inspec/resources/aws_glue_database.md | 10 +- .../inspec/resources/aws_glue_databases.md | 10 +- .../resources/aws_guardduty_detector.md | 10 +- .../resources/aws_guardduty_detectors.md | 10 +- .../inspec/resources/aws_hosted_zone.md | 10 +- .../inspec/resources/aws_hosted_zones.md | 8 +- .../inspec/resources/aws_iam_access_key.md | 10 +- .../inspec/resources/aws_iam_access_keys.md | 6 +- .../inspec/resources/aws_iam_account_alias.md | 6 +- .../content/inspec/resources/aws_iam_group.md | 6 +- .../inspec/resources/aws_iam_groups.md | 6 +- .../inspec/resources/aws_iam_inline_policy.md | 8 +- .../resources/aws_iam_instance_profile.md | 10 +- .../resources/aws_iam_instance_profiles.md | 8 +- .../resources/aws_iam_managed_policies.md | 8 +- .../resources/aws_iam_managed_policy.md | 8 +- .../inspec/resources/aws_iam_oidc_provider.md | 10 +- .../resources/aws_iam_oidc_providers.md | 8 +- .../resources/aws_iam_password_policy.md | 8 +- .../inspec/resources/aws_iam_policies.md | 8 +- .../inspec/resources/aws_iam_policy.md | 8 +- .../content/inspec/resources/aws_iam_role.md | 9 +- .../content/inspec/resources/aws_iam_roles.md | 8 +- .../inspec/resources/aws_iam_root_user.md | 8 +- .../inspec/resources/aws_iam_saml_provider.md | 8 +- .../resources/aws_iam_saml_providers.md | 6 +- .../resources/aws_iam_server_certificate.md | 10 +- .../resources/aws_iam_server_certificates.md | 8 +- ...iam_service_linked_role_deletion_status.md | 8 +- .../resources/aws_iam_ssh_public_key.md | 8 +- .../resources/aws_iam_ssh_public_keys.md | 8 +- .../content/inspec/resources/aws_iam_user.md | 49 ++-- .../content/inspec/resources/aws_iam_users.md | 6 +- .../resources/aws_iam_virtual_mfa_devices.md | 6 +- .../inspec/resources/aws_internet_gateway.md | 8 +- .../inspec/resources/aws_internet_gateways.md | 8 +- .../content/inspec/resources/aws_kms_key.md | 4 +- .../content/inspec/resources/aws_kms_keys.md | 10 +- .../content/inspec/resources/aws_lambda.md | 8 +- .../inspec/resources/aws_lambda_alias.md | 10 +- .../inspec/resources/aws_lambda_aliases.md | 8 +- .../aws_lambda_code_signing_config.md | 10 +- .../aws_lambda_code_signing_configs.md | 8 +- .../aws_lambda_event_invoke_config.md | 10 +- .../aws_lambda_event_invoke_configs.md | 8 +- .../aws_lambda_event_source_mapping.md | 10 +- .../aws_lambda_event_source_mappings.md | 8 +- .../aws_lambda_layer_version_permission.md | 10 +- .../inspec/resources/aws_lambda_permission.md | 10 +- .../resources/aws_lambda_permissions.md | 10 +- .../inspec/resources/aws_lambda_version.md | 10 +- .../inspec/resources/aws_lambda_versions.md | 8 +- .../content/inspec/resources/aws_lambdas.md | 8 +- .../resources/aws_launch_configuration.md | 10 +- .../resources/aws_logs_metric_filter.md | 8 +- .../resources/aws_logs_metric_filters.md | 8 +- .../content/inspec/resources/aws_mq_broker.md | 8 +- .../inspec/resources/aws_mq_brokers.md | 8 +- .../inspec/resources/aws_mq_configuration.md | 8 +- .../inspec/resources/aws_mq_configurations.md | 8 +- .../inspec/resources/aws_nat_gateway.md | 10 +- .../inspec/resources/aws_nat_gateways.md | 11 +- .../inspec/resources/aws_network_acl.md | 10 +- .../inspec/resources/aws_network_acls.md | 10 +- .../aws_network_firewall_firewall.md | 8 +- .../aws_network_firewall_firewall_policies.md | 8 +- .../aws_network_firewall_firewall_policy.md | 8 +- .../aws_network_firewall_firewalls.md | 8 +- ..._network_firewall_logging_configuration.md | 8 +- .../aws_network_firewall_rule_group.md | 8 +- .../aws_network_firewall_rule_groups.md | 8 +- ...rk_manager_customer_gateway_association.md | 10 +- ...k_manager_customer_gateway_associations.md | 10 +- .../resources/aws_network_manager_device.md | 10 +- .../resources/aws_network_manager_devices.md | 10 +- .../aws_network_manager_global_network.md | 10 +- .../aws_network_manager_global_networks.md | 10 +- .../resources/aws_organizations_member.md | 8 +- .../resources/aws_ram_resource_share.md | 10 +- .../resources/aws_ram_resource_shares.md | 10 +- .../inspec/resources/aws_rds_cluster.md | 10 +- .../inspec/resources/aws_rds_clusters.md | 10 +- .../resources/aws_rds_db_cluster_snapshot.md | 8 +- .../resources/aws_rds_db_cluster_snapshots.md | 8 +- .../inspec/resources/aws_rds_db_proxy.md | 8 +- .../resources/aws_rds_db_proxy_endpoint.md | 8 +- .../resources/aws_rds_db_proxy_endpoints.md | 8 +- .../aws_rds_db_proxy_target_group.md | 8 +- .../aws_rds_db_proxy_target_groups.md | 8 +- .../resources/aws_rds_db_security_group.md | 8 +- .../resources/aws_rds_db_security_groups.md | 8 +- .../resources/aws_rds_event_subscription.md | 8 +- .../resources/aws_rds_event_subscriptions.md | 8 +- .../resources/aws_rds_global_cluster.md | 8 +- .../resources/aws_rds_global_clusters.md | 8 +- .../inspec/resources/aws_rds_group_option.md | 10 +- .../inspec/resources/aws_rds_group_options.md | 12 +- .../inspec/resources/aws_rds_instance.md | 10 +- .../inspec/resources/aws_rds_instances.md | 10 +- .../inspec/resources/aws_rds_snapshot.md | 10 +- .../resources/aws_rds_snapshot_attributes.md | 10 +- .../inspec/resources/aws_rds_snapshots.md | 10 +- .../inspec/resources/aws_redshift_cluster.md | 10 +- .../aws_redshift_cluster_parameter_group.md | 8 +- .../aws_redshift_cluster_parameter_groups.md | 10 +- .../inspec/resources/aws_redshift_clusters.md | 10 +- .../content/inspec/resources/aws_region.md | 10 +- .../content/inspec/resources/aws_regions.md | 8 +- .../resources/aws_route53_record_set.md | 8 +- .../resources/aws_route53_record_sets.md | 8 +- .../aws_route53resolver_resolver_endpoint.md | 10 +- .../aws_route53resolver_resolver_endpoints.md | 8 +- .../aws_route53resolver_resolver_rule.md | 10 +- ...ute53resolver_resolver_rule_association.md | 10 +- ...te53resolver_resolver_rule_associations.md | 8 +- .../aws_route53resolver_resolver_rules.md | 8 +- .../inspec/resources/aws_route_table.md | 8 +- .../inspec/resources/aws_route_tables.md | 6 +- .../inspec/resources/aws_s3_access_point.md | 10 +- .../inspec/resources/aws_s3_access_points.md | 8 +- .../content/inspec/resources/aws_s3_bucket.md | 8 +- .../inspec/resources/aws_s3_bucket_object.md | 4 +- .../inspec/resources/aws_s3_bucket_objects.md | 8 +- .../inspec/resources/aws_s3_bucket_policy.md | 10 +- .../inspec/resources/aws_s3_buckets.md | 6 +- .../inspec/resources/aws_sdb_domains.md | 8 +- .../resources/aws_secretsmanager_secret.md | 8 +- .../resources/aws_secretsmanager_secrets.md | 8 +- .../inspec/resources/aws_security_group.md | 6 +- .../inspec/resources/aws_security_groups.md | 10 +- .../inspec/resources/aws_securityhub_hub.md | 8 +- ..._servicecatalog_cloud_formation_product.md | 8 +- ...s_servicecatalog_launch_role_constraint.md | 8 +- ..._servicecatalog_launch_role_constraints.md | 8 +- ...catalog_portfolio_principal_association.md | 8 +- ...atalog_portfolio_principal_associations.md | 8 +- ...cecatalog_portfolio_product_association.md | 8 +- ...ecatalog_portfolio_product_associations.md | 8 +- .../inspec/resources/aws_ses_receipt_rule.md | 8 +- .../resources/aws_ses_receipt_rule_set.md | 8 +- .../resources/aws_ses_receipt_rule_sets.md | 8 +- .../inspec/resources/aws_ses_template.md | 10 +- .../inspec/resources/aws_ses_templates.md | 8 +- .../resources/aws_shield_subscription.md | 8 +- .../aws_signer_profile_permissions.md | 8 +- .../resources/aws_signer_signing_profile.md | 10 +- .../resources/aws_signer_signing_profiles.md | 8 +- .../inspec/resources/aws_sns_subscription.md | 20 +- .../inspec/resources/aws_sns_subscriptions.md | 8 +- .../content/inspec/resources/aws_sns_topic.md | 10 +- .../inspec/resources/aws_sns_topics.md | 6 +- .../content/inspec/resources/aws_sqs_queue.md | 57 +++- .../inspec/resources/aws_sqs_queues.md | 10 +- .../inspec/resources/aws_ssm_activation.md | 10 +- .../inspec/resources/aws_ssm_activations.md | 10 +- .../inspec/resources/aws_ssm_association.md | 10 +- .../inspec/resources/aws_ssm_associations.md | 10 +- .../inspec/resources/aws_ssm_document.md | 10 +- .../inspec/resources/aws_ssm_documents.md | 10 +- .../resources/aws_ssm_maintenance_window.md | 12 +- .../aws_ssm_maintenance_window_target.md | 8 +- .../aws_ssm_maintenance_window_targets.md | 8 +- .../aws_ssm_maintenance_window_task.md | 8 +- .../aws_ssm_maintenance_window_tasks.md | 8 +- .../resources/aws_ssm_maintenance_windows.md | 8 +- .../inspec/resources/aws_ssm_parameter.md | 10 +- .../inspec/resources/aws_ssm_parameters.md | 10 +- .../resources/aws_ssm_patch_baseline.md | 10 +- .../resources/aws_ssm_patch_baselines.md | 8 +- .../aws_ssm_resource_compliance_summaries.md | 12 +- .../aws_ssm_resource_compliance_summary.md | 12 +- .../resources/aws_ssm_resource_data_syncs.md | 8 +- .../resources/aws_stepfunctions_activities.md | 8 +- .../resources/aws_stepfunctions_activity.md | 8 +- .../aws_stepfunctions_state_machine.md | 8 +- .../aws_stepfunctions_state_machines.md | 8 +- .../resources/aws_sts_caller_identity.md | 10 +- .../content/inspec/resources/aws_subnet.md | 10 +- .../content/inspec/resources/aws_subnets.md | 8 +- .../resources/aws_synthetics_canaries.md | 8 +- .../inspec/resources/aws_synthetics_canary.md | 10 +- .../inspec/resources/aws_transfer_user.md | 8 +- .../inspec/resources/aws_transfer_users.md | 8 +- .../inspec/resources/aws_transit_gateway.md | 10 +- .../resources/aws_transit_gateway_connect.md | 8 +- .../resources/aws_transit_gateway_connects.md | 8 +- .../aws_transit_gateway_multicast_domain.md | 8 +- ...it_gateway_multicast_domain_association.md | 10 +- ...t_gateway_multicast_domain_associations.md | 10 +- .../aws_transit_gateway_multicast_domains.md | 8 +- ..._transit_gateway_multicast_group_member.md | 8 +- ...transit_gateway_multicast_group_members.md | 8 +- ..._transit_gateway_multicast_group_source.md | 8 +- ...transit_gateway_multicast_group_sources.md | 8 +- .../resources/aws_transit_gateway_route.md | 6 +- .../resources/aws_transit_gateway_routes.md | 6 +- .../content/inspec/resources/aws_vpc.md | 6 +- .../inspec/resources/aws_vpc_endpoint.md | 8 +- .../aws_vpc_endpoint_notification.md | 6 +- .../aws_vpc_endpoint_notifications.md | 8 +- .../resources/aws_vpc_endpoint_service.md | 6 +- .../aws_vpc_endpoint_service_permission.md | 9 +- .../aws_vpc_endpoint_service_permissions.md | 10 +- .../resources/aws_vpc_endpoint_services.md | 6 +- .../inspec/resources/aws_vpc_endpoints.md | 10 +- .../content/inspec/resources/aws_vpcs.md | 8 +- .../inspec/resources/aws_vpn_connection.md | 105 +++++++ .../inspec/resources/aws_vpn_connections.md | 40 +-- .../inspec/resources/aws_vpn_gateway.md | 9 +- .../inspec/resources/aws_vpn_gateways.md | 10 +- .../resources/aws_waf_byte_match_set.md | 12 +- .../resources/aws_waf_byte_match_sets.md | 10 +- .../inspec/resources/aws_waf_ip_set.md | 10 +- .../inspec/resources/aws_waf_ip_sets.md | 8 +- .../content/inspec/resources/aws_waf_rule.md | 10 +- .../content/inspec/resources/aws_waf_rules.md | 8 +- .../resources/aws_waf_size_constraint_set.md | 12 +- .../resources/aws_waf_size_constraint_sets.md | 10 +- .../aws_waf_sql_injection_match_set.md | 10 +- .../aws_waf_sql_injection_match_sets.md | 8 +- .../inspec/resources/aws_waf_web_acl.md | 10 +- .../inspec/resources/aws_waf_web_acls.md | 8 +- .../resources/aws_waf_xss_match_match_set.md | 10 +- .../resources/aws_waf_xss_match_match_sets.md | 8 +- .../inspec/resources/reusable/index.md | 5 + .../reusable/md/inspec_aws_install.md | 4 + .../aws_permissions_principal.md | 0 .../layouts/shortcodes/inspec_aws_install.md | 4 - .../layouts/shortcodes/inspec_filter_table.md | 8 - .../azure_active_directory_domain_service.md | 31 +- .../azure_active_directory_domain_services.md | 37 ++- .../azure_active_directory_object.md | 37 +-- .../azure_active_directory_objects.md | 35 ++- .../inspec/resources/azure_aks_cluster.md | 68 +++-- .../inspec/resources/azure_aks_clusters.md | 52 ++-- .../inspec/resources/azure_api_management.md | 54 ++-- .../inspec/resources/azure_api_managements.md | 54 ++-- .../resources/azure_application_gateway.md | 51 ++-- .../resources/azure_application_gateways.md | 54 ++-- .../resources/azure_bastion_hosts_resource.md | 58 ++-- .../azure_bastion_hosts_resources.md | 34 ++- .../inspec/resources/azure_blob_service.md | 130 +++++++++ .../inspec/resources/azure_blob_services.md | 112 ++++++++ .../inspec/resources/azure_cdn_profile.md | 109 +++++++ .../inspec/resources/azure_cdn_profiles.md | 143 ++++++++++ .../inspec/resources/azure_container_group.md | 33 +-- .../resources/azure_container_groups.md | 38 ++- .../resources/azure_container_registries.md | 42 +-- .../resources/azure_container_registry.md | 44 +-- .../azure_cosmosdb_database_account.md | 51 ++-- .../inspec/resources/azure_data_factories.md | 33 ++- .../inspec/resources/azure_data_factory.md | 31 +- .../resources/azure_data_factory_dataset.md | 23 +- .../resources/azure_data_factory_datasets.md | 28 +- .../azure_data_factory_linked_service.md | 16 +- .../azure_data_factory_linked_services.md | 28 +- .../resources/azure_data_factory_pipeline.md | 27 +- ...zure_data_factory_pipeline_run_resource.md | 14 +- ...ure_data_factory_pipeline_run_resources.md | 25 +- .../resources/azure_data_factory_pipelines.md | 42 +-- ...azure_data_lake_storage_gen2_filesystem.md | 23 +- ...zure_data_lake_storage_gen2_filesystems.md | 36 ++- .../azure_data_lake_storage_gen2_path.md | 39 +-- .../azure_data_lake_storage_gen2_paths.md | 41 +-- .../resources/azure_db_migration_service.md | 51 ++-- .../resources/azure_db_migration_services.md | 48 ++-- .../azure_ddos_protection_resource.md | 44 +-- .../azure_ddos_protection_resources.md | 36 +-- .../resources/azure_dns_zones_resource.md | 29 +- .../resources/azure_dns_zones_resources.md | 32 ++- .../azure_event_hub_authorization_rule.md | 49 ++-- .../resources/azure_event_hub_event_hub.md | 49 ++-- .../resources/azure_event_hub_namespace.md | 47 +-- .../resources/azure_express_route_circuit.md | 48 ++-- .../resources/azure_express_route_circuits.md | 54 ++-- .../azure_express_route_providers.md | 48 ++-- .../resources/azure_generic_resource.md | 88 +++--- .../resources/azure_generic_resources.md | 95 ++++--- .../resources/azure_graph_generic_resource.md | 47 +-- .../azure_graph_generic_resources.md | 91 +++--- .../inspec/resources/azure_graph_user.md | 22 +- .../inspec/resources/azure_graph_users.md | 46 +-- .../resources/azure_hdinsight_cluster.md | 53 ++-- .../resources/azure_hpc_asc_operation.md | 108 +++++++ .../inspec/resources/azure_hpc_cache.md | 117 ++++++++ .../inspec/resources/azure_hpc_cache_skus.md | 99 +++++++ .../inspec/resources/azure_hpc_caches.md | 129 +++++++++ .../resources/azure_hpc_storage_target.md | 120 ++++++++ .../resources/azure_hpc_storage_targets.md | 132 +++++++++ .../content/inspec/resources/azure_iothub.md | 45 +-- .../azure_iothub_event_hub_consumer_group.md | 51 ++-- .../azure_iothub_event_hub_consumer_groups.md | 50 ++-- .../inspec/resources/azure_key_vault.md | 58 ++-- .../inspec/resources/azure_key_vault_key.md | 68 +++-- .../inspec/resources/azure_key_vault_keys.md | 50 ++-- .../resources/azure_key_vault_secret.md | 60 ++-- .../resources/azure_key_vault_secrets.md | 52 ++-- .../inspec/resources/azure_key_vaults.md | 59 ++-- .../inspec/resources/azure_load_balancer.md | 49 ++-- .../inspec/resources/azure_load_balancers.md | 62 ++-- .../content/inspec/resources/azure_lock.md | 48 ++-- .../content/inspec/resources/azure_locks.md | 66 +++-- .../resources/azure_managed_application.md | 117 ++++++++ .../resources/azure_managed_applications.md | 139 +++++++++ .../resources/azure_management_group.md | 53 ++-- .../resources/azure_management_groups.md | 38 ++- .../inspec/resources/azure_mariadb_server.md | 63 ++-- .../inspec/resources/azure_mariadb_servers.md | 49 ++-- .../azure_microsoft_defender_pricing.md | 96 +++++++ .../azure_microsoft_defender_pricings.md | 105 +++++++ ...ure_microsoft_defender_security_contact.md | 119 ++++++++ .../azure_microsoft_defender_setting.md | 79 ++++++ .../azure_microsoft_defender_settings.md | 92 ++++++ .../resources/azure_migrate_assessment.md | 30 +- .../azure_migrate_assessment_group.md | 31 +- .../azure_migrate_assessment_groups.md | 38 ++- .../azure_migrate_assessment_machine.md | 33 ++- .../azure_migrate_assessment_machines.md | 58 ++-- .../azure_migrate_assessment_project.md | 36 +-- .../azure_migrate_assessment_projects.md | 48 ++-- .../resources/azure_migrate_assessments.md | 52 ++-- .../inspec/resources/azure_migrate_project.md | 41 ++- .../azure_migrate_project_database.md | 34 ++- ...azure_migrate_project_database_instance.md | 32 ++- ...zure_migrate_project_database_instances.md | 37 ++- .../azure_migrate_project_databases.md | 44 +-- .../resources/azure_migrate_project_event.md | 33 ++- .../resources/azure_migrate_project_events.md | 43 +-- .../azure_migrate_project_machine.md | 43 +-- .../azure_migrate_project_machines.md | 50 ++-- .../azure_migrate_project_solution.md | 28 +- .../azure_migrate_project_solutions.md | 47 +-- .../azure_monitor_activity_log_alert.md | 59 ++-- .../azure_monitor_activity_log_alerts.md | 48 ++-- .../resources/azure_monitor_log_profile.md | 68 +++-- .../resources/azure_monitor_log_profiles.md | 42 +-- .../inspec/resources/azure_mysql_database.md | 46 +-- .../inspec/resources/azure_mysql_databases.md | 59 ++-- .../inspec/resources/azure_mysql_server.md | 55 ++-- .../azure_mysql_server_configuration.md | 123 ++++++++ .../azure_mysql_server_configurations.md | 116 ++++++++ .../inspec/resources/azure_mysql_servers.md | 49 ++-- .../resources/azure_network_interface.md | 63 ++-- .../resources/azure_network_interfaces.md | 54 ++-- .../resources/azure_network_security_group.md | 114 +++++--- .../azure_network_security_groups.md | 54 ++-- .../inspec/resources/azure_network_watcher.md | 60 ++-- .../resources/azure_network_watchers.md | 44 +-- .../resources/azure_policy_assignments.md | 14 +- .../resources/azure_policy_definition.md | 61 ++-- .../resources/azure_policy_definitions.md | 40 ++- .../resources/azure_policy_exemption.md | 27 +- .../resources/azure_policy_exemptions.md | 65 +++-- .../azure_policy_insights_query_result.md | 45 +-- .../azure_policy_insights_query_results.md | 56 ++-- .../resources/azure_postgresql_database.md | 44 +-- .../resources/azure_postgresql_databases.md | 55 ++-- .../resources/azure_postgresql_server.md | 86 +++--- .../resources/azure_postgresql_servers.md | 49 ++-- .../inspec/resources/azure_power_bi_app.md | 19 +- .../resources/azure_power_bi_app_dashboard.md | 95 +++++++ .../azure_power_bi_app_dashboard_tile.md | 31 +- .../azure_power_bi_app_dashboard_tiles.md | 36 ++- .../azure_power_bi_app_dashboards.md | 116 ++++++++ .../resources/azure_power_bi_app_report.md | 105 +++++++ .../resources/azure_power_bi_app_reports.md | 127 +++++++++ .../inspec/resources/azure_power_bi_apps.md | 28 +- .../resources/azure_power_bi_capacities.md | 23 +- .../azure_power_bi_capacity_refreshable.md | 21 +- .../azure_power_bi_capacity_refreshables.md | 33 ++- .../azure_power_bi_capacity_workload.md | 100 +++++++ .../azure_power_bi_capacity_workloads.md | 100 +++++++ .../resources/azure_power_bi_dashboard.md | 20 +- .../azure_power_bi_dashboard_tile.md | 28 +- .../azure_power_bi_dashboard_tiles.md | 31 +- .../resources/azure_power_bi_dashboards.md | 29 +- .../resources/azure_power_bi_dataflow.md | 16 +- ...zure_power_bi_dataflow_storage_accounts.md | 100 +++++++ .../resources/azure_power_bi_dataflows.md | 59 ++-- .../resources/azure_power_bi_dataset.md | 24 +- .../azure_power_bi_dataset_datasources.md | 24 +- .../resources/azure_power_bi_datasets.md | 36 ++- .../azure_power_bi_embedded_capacities.md | 149 ++++++++++ .../azure_power_bi_embedded_capacity.md | 120 ++++++++ .../resources/azure_power_bi_gateway.md | 24 +- .../resources/azure_power_bi_gateways.md | 32 ++- .../inspec/resources/azure_public_ip.md | 52 ++-- .../inspec/resources/azure_redis_cache.md | 43 +-- .../inspec/resources/azure_redis_caches.md | 52 ++-- .../inspec/resources/azure_resource_group.md | 61 ++-- .../inspec/resources/azure_resource_groups.md | 30 +- ...ure_resource_health_availability_status.md | 30 +- ...e_resource_health_availability_statuses.md | 39 ++- .../azure_resource_health_emerging_issue.md | 29 +- .../azure_resource_health_emerging_issues.md | 34 ++- .../resources/azure_resource_health_events.md | 37 ++- .../inspec/resources/azure_role_definition.md | 40 +-- .../resources/azure_role_definitions.md | 41 ++- .../azure_security_center_policies.md | 36 ++- .../resources/azure_security_center_policy.md | 61 ++-- .../azure_sentinel_alert_rule_template.md | 128 --------- .../azure_sentinel_alert_rule_templates.md | 150 ---------- .../azure_sentinel_incidents_resource.md | 124 -------- .../azure_sentinel_incidents_resources.md | 138 --------- .../resources/azure_service_bus_namespace.md | 120 ++++++++ .../resources/azure_service_bus_namespaces.md | 144 ++++++++++ .../resources/azure_service_bus_regions.md | 119 ++++++++ .../azure_service_bus_subscription.md | 112 ++++++++ .../azure_service_bus_subscription_rule.md | 115 ++++++++ .../azure_service_bus_subscription_rules.md | 123 ++++++++ .../azure_service_bus_subscriptions.md | 120 ++++++++ .../resources/azure_service_bus_topic.md | 117 ++++++++ .../resources/azure_service_bus_topics.md | 139 +++++++++ .../azure_service_fabric_mesh_application.md | 118 ++++++++ .../azure_service_fabric_mesh_applications.md | 134 +++++++++ .../azure_service_fabric_mesh_network.md | 119 ++++++++ .../azure_service_fabric_mesh_networks.md | 129 +++++++++ .../azure_service_fabric_mesh_replica.md | 109 +++++++ .../azure_service_fabric_mesh_replicas.md | 110 +++++++ .../azure_service_fabric_mesh_service.md | 111 ++++++++ .../azure_service_fabric_mesh_services.md | 129 +++++++++ .../azure_service_fabric_mesh_volume.md | 115 ++++++++ .../azure_service_fabric_mesh_volumes.md | 134 +++++++++ .../inspec/resources/azure_snapshot.md | 126 ++++++++ .../inspec/resources/azure_snapshots.md | 113 ++++++++ .../inspec/resources/azure_sql_database.md | 84 +++--- ...atabase_server_vulnerability_assessment.md | 100 +++++++ ...tabase_server_vulnerability_assessments.md | 129 +++++++++ .../inspec/resources/azure_sql_databases.md | 60 ++-- .../resources/azure_sql_managed_instance.md | 39 +-- .../resources/azure_sql_managed_instances.md | 41 ++- .../inspec/resources/azure_sql_server.md | 82 +++--- .../inspec/resources/azure_sql_servers.md | 49 ++-- .../resources/azure_sql_virtual_machine.md | 28 +- .../azure_sql_virtual_machine_group.md | 32 ++- ...ual_machine_group_availability_listener.md | 28 +- ...al_machine_group_availability_listeners.md | 37 ++- .../azure_sql_virtual_machine_groups.md | 37 ++- .../resources/azure_sql_virtual_machines.md | 37 ++- .../inspec/resources/azure_storage_account.md | 98 ++++--- .../azure_storage_account_blob_container.md | 60 ++-- .../azure_storage_account_blob_containers.md | 48 ++-- .../resources/azure_storage_accounts.md | 51 ++-- .../azure_streaming_analytics_function.md | 34 +-- .../azure_streaming_analytics_functions.md | 35 ++- .../content/inspec/resources/azure_subnet.md | 268 +++--------------- .../content/inspec/resources/azure_subnets.md | 44 +-- .../inspec/resources/azure_subscription.md | 75 +++-- .../inspec/resources/azure_subscriptions.md | 34 ++- .../resources/azure_synapse_notebook.md | 25 +- .../resources/azure_synapse_notebooks.md | 39 +-- .../resources/azure_synapse_workspace.md | 109 +++++++ .../resources/azure_synapse_workspaces.md | 124 ++++++++ .../inspec/resources/azure_virtual_machine.md | 52 ++-- .../resources/azure_virtual_machine_disk.md | 77 +++-- .../resources/azure_virtual_machine_disks.md | 66 +++-- .../resources/azure_virtual_machines.md | 76 +++-- .../inspec/resources/azure_virtual_network.md | 61 ++-- .../azure_virtual_network_gateway.md | 26 +- ...zure_virtual_network_gateway_connection.md | 25 +- ...ure_virtual_network_gateway_connections.md | 32 ++- .../azure_virtual_network_gateways.md | 52 ++-- .../azure_virtual_network_peering.md | 52 ++-- .../azure_virtual_network_peerings.md | 38 ++- .../resources/azure_virtual_networks.md | 58 ++-- .../inspec/resources/azure_virtual_wan.md | 26 +- .../inspec/resources/azure_virtual_wans.md | 32 ++- .../resources/azure_web_app_function.md | 48 ++-- .../resources/azure_web_app_functions.md | 48 ++-- .../content/inspec/resources/azure_webapp.md | 70 +++-- .../content/inspec/resources/azure_webapps.md | 52 ++-- .../inspec/resources/reusable/index.md | 5 + .../md}/inspec_azure_common_parameters.md | 0 .../reusable/md/inspec_azure_install.md | 4 + .../azure_permissions_service_principal.md | 0 .../shortcodes/inspec_azure_install.md | 4 - .../layouts/shortcodes/inspec_filter_table.md | 8 - .../inspec/resources/k8s_api_resources.md | 2 +- .../inspec/resources/k8s_config_map.md | 2 +- .../inspec/resources/k8s_config_maps.md | 2 +- .../content/inspec/resources/k8s_container.md | 4 + .../inspec/resources/k8s_containers.md | 2 +- .../content/inspec/resources/k8s_cronjob.md | 2 +- .../content/inspec/resources/k8s_cronjobs.md | 2 +- .../inspec/resources/k8s_daemon_set.md | 2 +- .../inspec/resources/k8s_daemon_sets.md | 2 +- .../inspec/resources/k8s_deployment.md | 2 +- .../inspec/resources/k8s_deployments.md | 2 +- .../content/inspec/resources/k8s_exec_file.md | 2 +- .../content/inspec/resources/k8s_job.md | 2 +- .../content/inspec/resources/k8s_jobs.md | 2 +- .../content/inspec/resources/k8s_namespace.md | 2 +- .../inspec/resources/k8s_namespaces.md | 2 +- .../inspec/resources/k8s_network_policies.md | 2 +- .../inspec/resources/k8s_network_policy.md | 2 +- .../content/inspec/resources/k8s_node.md | 2 +- .../content/inspec/resources/k8s_nodes.md | 2 +- .../content/inspec/resources/k8s_object.md | 2 +- .../content/inspec/resources/k8s_objects.md | 2 +- .../content/inspec/resources/k8s_pod.md | 4 + .../content/inspec/resources/k8s_pods.md | 2 +- .../inspec/resources/k8s_rbac_cluster_role.md | 2 +- .../resources/k8s_rbac_cluster_roles.md | 2 +- .../content/inspec/resources/aide_conf.md | 6 +- .../content/inspec/resources/apache.md | 4 +- .../content/inspec/resources/apache_conf.md | 7 +- .../content/inspec/resources/apt.md | 8 +- .../content/inspec/resources/audit_policy.md | 6 +- .../content/inspec/resources/auditd.md | 6 +- .../content/inspec/resources/auditd_conf.md | 8 +- .../inspec/resources/azurerm_ad_user.md | 6 +- .../inspec/resources/azurerm_ad_users.md | 6 +- .../inspec/resources/azurerm_aks_cluster.md | 6 +- .../inspec/resources/azurerm_aks_clusters.md | 6 +- .../azurerm_cosmosdb_database_account.md | 6 +- .../azurerm_event_hub_authorization_rule.md | 6 +- .../resources/azurerm_event_hub_event_hub.md | 6 +- .../resources/azurerm_event_hub_namespace.md | 6 +- .../inspec/resources/azurerm_iothub.md | 6 +- ...azurerm_iothub_event_hub_consumer_group.md | 6 +- ...zurerm_iothub_event_hub_consumer_groups.md | 6 +- .../inspec/resources/azurerm_key_vault.md | 6 +- .../inspec/resources/azurerm_key_vault_key.md | 6 +- .../resources/azurerm_key_vault_keys.md | 6 +- .../resources/azurerm_key_vault_secret.md | 6 +- .../resources/azurerm_key_vault_secrets.md | 6 +- .../inspec/resources/azurerm_key_vaults.md | 6 +- .../inspec/resources/azurerm_load_balancer.md | 6 +- .../resources/azurerm_load_balancers.md | 6 +- .../content/inspec/resources/azurerm_locks.md | 6 +- .../resources/azurerm_management_group.md | 6 +- .../resources/azurerm_management_groups.md | 2 +- .../azurerm_monitor_activity_log_alert.md | 6 +- .../azurerm_monitor_activity_log_alerts.md | 6 +- .../resources/azurerm_monitor_log_profile.md | 6 +- .../resources/azurerm_monitor_log_profiles.md | 6 +- .../resources/azurerm_mysql_database.md | 6 +- .../resources/azurerm_mysql_databases.md | 6 +- .../inspec/resources/azurerm_mysql_server.md | 6 +- .../inspec/resources/azurerm_mysql_servers.md | 6 +- .../resources/azurerm_network_interface.md | 6 +- .../resources/azurerm_network_interfaces.md | 6 +- .../azurerm_network_security_group.md | 6 +- .../azurerm_network_security_groups.md | 6 +- .../resources/azurerm_network_watcher.md | 6 +- .../resources/azurerm_network_watchers.md | 6 +- .../resources/azurerm_postgresql_database.md | 6 +- .../resources/azurerm_postgresql_databases.md | 6 +- .../resources/azurerm_postgresql_server.md | 6 +- .../resources/azurerm_postgresql_servers.md | 6 +- .../resources/azurerm_resource_groups.md | 6 +- .../resources/azurerm_role_definition.md | 6 +- .../resources/azurerm_role_definitions.md | 6 +- .../azurerm_security_center_policies.md | 6 +- .../azurerm_security_center_policy.md | 6 +- .../inspec/resources/azurerm_sql_database.md | 6 +- .../inspec/resources/azurerm_sql_databases.md | 6 +- .../inspec/resources/azurerm_sql_server.md | 6 +- .../inspec/resources/azurerm_sql_servers.md | 6 +- .../azurerm_storage_account_blob_container.md | 6 +- ...azurerm_storage_account_blob_containers.md | 6 +- .../inspec/resources/azurerm_subnet.md | 6 +- .../inspec/resources/azurerm_subnets.md | 6 +- .../inspec/resources/azurerm_subscription.md | 6 +- .../resources/azurerm_virtual_machine.md | 6 +- .../resources/azurerm_virtual_machine_disk.md | 6 +- .../azurerm_virtual_machine_disks.md | 6 +- .../resources/azurerm_virtual_machines.md | 6 +- .../resources/azurerm_virtual_network.md | 6 +- .../resources/azurerm_virtual_networks.md | 6 +- .../inspec/resources/azurerm_webapp.md | 6 +- .../inspec/resources/azurerm_webapps.md | 6 +- .../content/inspec/resources/bash.md | 8 +- .../content/inspec/resources/bond.md | 8 +- .../content/inspec/resources/bridge.md | 8 +- .../content/inspec/resources/bsd_service.md | 8 +- .../inspec/resources/cassandradb_conf.md | 4 +- .../inspec/resources/cassandradb_session.md | 6 +- .../content/inspec/resources/cgroup.md | 2 +- .../inspec/resources/chocolatey_package.md | 4 +- .../content/inspec/resources/chrony_conf.md | 6 +- .../content/inspec/resources/command.md | 8 +- .../content/inspec/resources/cpan.md | 8 +- .../content/inspec/resources/cran.md | 4 +- .../content/inspec/resources/cron.md | 2 +- .../content/inspec/resources/crontab.md | 6 +- .../content/inspec/resources/csv.md | 6 +- .../inspec/resources/default_gateway.md | 2 +- .../content/inspec/resources/dh_params.md | 8 +- .../content/inspec/resources/directory.md | 6 +- .../content/inspec/resources/docker.md | 6 +- .../inspec/resources/docker_container.md | 5 +- .../content/inspec/resources/docker_image.md | 6 +- .../inspec/resources/docker_service.md | 8 +- .../content/inspec/resources/elasticsearch.md | 6 +- .../content/inspec/resources/etc_fstab.md | 6 +- .../content/inspec/resources/etc_group.md | 6 +- .../content/inspec/resources/etc_hosts.md | 6 +- .../inspec/resources/etc_hosts_allow.md | 6 +- .../inspec/resources/etc_hosts_deny.md | 6 +- .../content/inspec/resources/file.md | 18 +- .../content/inspec/resources/filesystem.md | 6 +- .../content/inspec/resources/firewalld.md | 8 +- .../content/inspec/resources/gem.md | 8 +- .../content/inspec/resources/group.md | 6 +- .../content/inspec/resources/groups.md | 8 +- .../content/inspec/resources/grub_conf.md | 6 +- .../content/inspec/resources/host.md | 6 +- .../content/inspec/resources/http.md | 6 +- .../content/inspec/resources/ibmdb2_conf.md | 6 +- .../inspec/resources/ibmdb2_session.md | 6 +- .../content/inspec/resources/iis_app.md | 8 +- .../content/inspec/resources/iis_site.md | 8 +- .../content/inspec/resources/inetd_conf.md | 6 +- .../content/inspec/resources/ini.md | 6 +- .../content/inspec/resources/interface.md | 8 +- .../content/inspec/resources/ip6tables.md | 8 +- .../content/inspec/resources/ipfilter.md | 8 +- .../content/inspec/resources/ipnat.md | 8 +- .../content/inspec/resources/iptables.md | 8 +- .../content/inspec/resources/json.md | 6 +- .../content/inspec/resources/kernel_module.md | 8 +- .../inspec/resources/kernel_parameter.md | 6 +- .../inspec/resources/kernel_parameters.md | 6 +- .../content/inspec/resources/key_rsa.md | 8 +- .../inspec/resources/launchd_service.md | 8 +- .../content/inspec/resources/limits_conf.md | 6 +- .../inspec/resources/linux_audit_system.md | 2 +- .../content/inspec/resources/login_defs.md | 6 +- .../content/inspec/resources/lxc.md | 2 +- .../content/inspec/resources/mail_alias.md | 2 +- .../content/inspec/resources/mongodb_conf.md | 6 +- .../inspec/resources/mongodb_session.md | 8 +- .../content/inspec/resources/mount.md | 8 +- .../content/inspec/resources/mssql_session.md | 6 +- .../inspec/resources/mssql_sys_conf.md | 4 +- .../content/inspec/resources/mysql_conf.md | 6 +- .../content/inspec/resources/mysql_session.md | 6 +- .../content/inspec/resources/nftables.md | 8 +- .../content/inspec/resources/nginx.md | 4 +- .../content/inspec/resources/nginx_conf.md | 8 +- .../content/inspec/resources/npm.md | 8 +- .../content/inspec/resources/ntp_conf.md | 7 +- .../content/inspec/resources/oneget.md | 8 +- .../content/inspec/resources/opa_api.md | 6 +- .../content/inspec/resources/opa_cli.md | 6 +- .../content/inspec/resources/oracledb_conf.md | 4 +- .../resources/oracledb_listener_conf.md | 4 +- .../inspec/resources/oracledb_session.md | 6 +- .../content/inspec/resources/os.md | 8 +- .../content/inspec/resources/os_env.md | 8 +- .../content/inspec/resources/package.md | 8 +- .../content/inspec/resources/packages.md | 6 +- .../content/inspec/resources/parse_config.md | 6 +- .../inspec/resources/parse_config_file.md | 12 +- .../content/inspec/resources/passwd.md | 6 +- .../content/inspec/resources/php_config.md | 2 +- .../content/inspec/resources/pip.md | 8 +- .../content/inspec/resources/podman.md | 4 +- .../inspec/resources/podman_container.md | 5 +- .../content/inspec/resources/podman_image.md | 6 +- .../inspec/resources/podman_network.md | 6 +- .../content/inspec/resources/podman_pod.md | 6 +- .../content/inspec/resources/podman_volume.md | 6 +- .../content/inspec/resources/port.md | 6 +- .../content/inspec/resources/postfix_conf.md | 6 +- .../content/inspec/resources/postgres_conf.md | 6 +- .../inspec/resources/postgres_hba_conf.md | 6 +- .../inspec/resources/postgres_ident_conf.md | 6 +- .../inspec/resources/postgres_session.md | 6 +- .../content/inspec/resources/powershell.md | 6 +- .../content/inspec/resources/ppa.md | 2 +- .../content/inspec/resources/processes.md | 2 +- .../inspec/resources/rabbitmq_config.md | 6 +- .../content/inspec/resources/registry_key.md | 8 +- .../content/inspec/resources/routing_table.md | 2 +- .../content/inspec/resources/runit_service.md | 8 +- .../inspec/resources/security_identifier.md | 8 +- .../inspec/resources/security_policy.md | 6 +- .../content/inspec/resources/selinux.md | 8 +- .../content/inspec/resources/service.md | 2 +- .../content/inspec/resources/shadow.md | 4 +- .../content/inspec/resources/ssh_config.md | 8 +- .../content/inspec/resources/ssh_key.md | 114 ++++++++ .../content/inspec/resources/sshd_config.md | 8 +- .../content/inspec/resources/ssl.md | 8 +- .../content/inspec/resources/sybase_conf.md | 6 +- .../inspec/resources/sybase_session.md | 6 +- .../content/inspec/resources/sys_info.md | 6 +- .../inspec/resources/systemd_service.md | 8 +- .../content/inspec/resources/sysv_service.md | 8 +- .../content/inspec/resources/timezone.md | 6 +- .../content/inspec/resources/toml.md | 6 +- .../inspec/resources/upstart_service.md | 8 +- .../content/inspec/resources/user.md | 6 +- .../content/inspec/resources/users.md | 8 +- .../content/inspec/resources/vbscript.md | 6 +- .../inspec/resources/virtualization.md | 8 +- .../inspec/resources/windows_feature.md | 8 +- .../inspec/resources/windows_firewall.md | 8 +- .../inspec/resources/windows_firewall_rule.md | 8 +- .../inspec/resources/windows_hotfix.md | 8 +- .../content/inspec/resources/windows_task.md | 6 +- .../content/inspec/resources/wmi.md | 6 +- .../inspec/resources/x509_certificate.md | 2 +- .../inspec/resources/x509_private_key.md | 2 +- .../content/inspec/resources/xinetd_conf.md | 8 +- .../content/inspec/resources/xml.md | 8 +- .../content/inspec/resources/yaml.md | 8 +- .../content/inspec/resources/yum.md | 8 +- .../content/inspec/resources/zfs.md | 2 +- .../content/inspec/resources/zfs_dataset.md | 8 +- .../content/inspec/resources/zfs_pool.md | 6 +- .../inspec/reusable/md/inspec_filter_table.md | 2 +- .../reusable/md}/inspec_installation.md | 0 .../reusable/md/inspec_matchers_link.md | 1 + .../shortcodes/inspec/inspec_filter_table.md | 8 - .../shortcodes/inspec/inspec_matchers_link.md | 2 - .../layouts/shortcodes/inspec_filter_table.md | 8 - .../shortcodes/inspec_matchers_link.md | 2 - _vendor/modules.txt | 10 +- .../inspec/reusable/md/inspec_installation.md | 1 - .../reusable/md/inspec_matchers_link.md | 2 - go.mod | 10 +- go.sum | 20 +- .../shortcodes/inspec/inspec_filter_table.md | 7 - .../shortcodes/inspec/inspec_installation.md | 1 - .../shortcodes/inspec/inspec_matchers_link.md | 2 - layouts/shortcodes/inspec_filter_table.md | 8 - layouts/shortcodes/inspec_matchers_link.md | 2 - 1004 files changed, 18781 insertions(+), 6697 deletions(-) create mode 100644 _vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ims_user.md create mode 100644 _vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/reusable/index.md rename _vendor/github.com/inspec/inspec-alicloud/docs-chef-io/{layouts/shortcodes => content/inspec/resources/reusable/md}/alibaba_access_management_doc.md (100%) rename _vendor/github.com/inspec/inspec-alicloud/docs-chef-io/{layouts/shortcodes => content/inspec/resources/reusable/md}/alibaba_authentication_ecs_api_doc.md (100%) rename _vendor/github.com/inspec/inspec-alicloud/docs-chef-io/{layouts/shortcodes => content/inspec/resources/reusable/md}/alibaba_authentication_ram_api_doc.md (100%) rename _vendor/github.com/inspec/inspec-alicloud/docs-chef-io/layouts/shortcodes/{ => inspec-alicloud}/alicloud_principal_action.md (100%) create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_domain_name.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_domain_names.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_request_validator.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_request_validators.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_resource.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_resources.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plan.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plan_key.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plan_keys.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plans.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_api.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_api_mapping.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_api_mappings.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_apis.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_authorizer.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_authorizers.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_deployment.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_deployments.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_domain_name.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_domain_names.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integration.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integration_response.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integration_responses.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integrations.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_model.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_models.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_route.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_routes.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_vpc_link.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_vpc_links.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_connection.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/reusable/index.md create mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/reusable/md/inspec_aws_install.md rename _vendor/github.com/inspec/inspec-aws/docs-chef-io/layouts/shortcodes/{ => inspec-aws}/aws_permissions_principal.md (100%) delete mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/layouts/shortcodes/inspec_aws_install.md delete mode 100644 _vendor/github.com/inspec/inspec-aws/docs-chef-io/layouts/shortcodes/inspec_filter_table.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_blob_service.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_blob_services.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_cdn_profile.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_cdn_profiles.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_asc_operation.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_cache.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_cache_skus.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_caches.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_storage_target.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_storage_targets.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_managed_application.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_managed_applications.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_pricing.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_pricings.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_security_contact.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_setting.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_settings.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_server_configuration.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_server_configurations.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboard.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboards.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_report.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_reports.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_workload.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_workloads.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataflow_storage_accounts.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_embedded_capacities.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_embedded_capacity.md delete mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_alert_rule_template.md delete mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_alert_rule_templates.md delete mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_incidents_resource.md delete mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_incidents_resources.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_namespace.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_namespaces.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_regions.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscription.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscription_rule.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscription_rules.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscriptions.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_topic.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_topics.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_application.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_applications.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_network.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_networks.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_replica.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_replicas.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_service.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_services.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_volume.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_volumes.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_snapshot.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_snapshots.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_database_server_vulnerability_assessment.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_database_server_vulnerability_assessments.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_workspace.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_workspaces.md create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/reusable/index.md rename _vendor/github.com/inspec/inspec-azure/docs-chef-io/{layouts/shortcodes => content/inspec/resources/reusable/md}/inspec_azure_common_parameters.md (100%) create mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/reusable/md/inspec_azure_install.md rename _vendor/github.com/inspec/inspec-azure/docs-chef-io/layouts/shortcodes/{ => inspec-azure}/azure_permissions_service_principal.md (100%) delete mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/layouts/shortcodes/inspec_azure_install.md delete mode 100644 _vendor/github.com/inspec/inspec-azure/docs-chef-io/layouts/shortcodes/inspec_filter_table.md create mode 100644 _vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/ssh_key.md rename {content => _vendor/github.com/inspec/inspec/docs-chef-io/content}/inspec/reusable/md/inspec_filter_table.md (72%) rename _vendor/github.com/inspec/inspec/docs-chef-io/{layouts/shortcodes/inspec => content/inspec/reusable/md}/inspec_installation.md (100%) create mode 100644 _vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/reusable/md/inspec_matchers_link.md delete mode 100644 _vendor/github.com/inspec/inspec/docs-chef-io/layouts/shortcodes/inspec/inspec_filter_table.md delete mode 100644 _vendor/github.com/inspec/inspec/docs-chef-io/layouts/shortcodes/inspec/inspec_matchers_link.md delete mode 100644 _vendor/github.com/inspec/inspec/docs-chef-io/layouts/shortcodes/inspec_filter_table.md delete mode 100644 _vendor/github.com/inspec/inspec/docs-chef-io/layouts/shortcodes/inspec_matchers_link.md delete mode 100644 content/inspec/reusable/md/inspec_installation.md delete mode 100644 content/inspec/reusable/md/inspec_matchers_link.md delete mode 100644 layouts/shortcodes/inspec/inspec_filter_table.md delete mode 100644 layouts/shortcodes/inspec/inspec_installation.md delete mode 100644 layouts/shortcodes/inspec/inspec_matchers_link.md delete mode 100644 layouts/shortcodes/inspec_filter_table.md delete mode 100644 layouts/shortcodes/inspec_matchers_link.md diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_apsaradb_rds_instance.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_apsaradb_rds_instance.md index d38dd22768..2d6608b934 100644 --- a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_apsaradb_rds_instance.md +++ b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_apsaradb_rds_instance.md @@ -143,7 +143,7 @@ end ## Matchers -{{% inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### exist diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_apsaradb_rds_instances.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_apsaradb_rds_instances.md index 6d61ccaa9f..6ce28a0ea2 100644 --- a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_apsaradb_rds_instances.md +++ b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_apsaradb_rds_instances.md @@ -126,7 +126,7 @@ end ## Matchers -{{% inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### exist @@ -148,6 +148,6 @@ end ### Alicloud Permissions -{{% alicloud_principal_action action="rds:DescribeDBInstances" %}} +{{% inspec-alicloud/alicloud_principal_action action="rds:DescribeDBInstances" %}} You can find documentation at [Use RAM to manage ApsaraDB for RDS permissions](https://www.alibabacloud.com/help/doc-detail/58932.htm#section-rhd-4ll-5gb). diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_disk.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_disk.md index b42123a672..3c9a45d419 100644 --- a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_disk.md +++ b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_disk.md @@ -108,7 +108,7 @@ end ## Matchers -{{% inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### exist @@ -138,7 +138,7 @@ it { should be_encrypted } ### Alicloud Permissions -{{% alicloud_principal_action action="ecs:DescribeDisks" %}} +{{% inspec-alicloud/alicloud_principal_action action="ecs:DescribeDisks" %}} -{{% alibaba_access_management_doc %}} -{{% alibaba_authentication_ecs_api_doc %}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ecs_api_doc.md" >}} diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_disks.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_disks.md index 48701d9a24..6dba1c4e4d 100644 --- a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_disks.md +++ b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_disks.md @@ -96,7 +96,7 @@ end ## Matchers -{{% inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### exist @@ -118,7 +118,7 @@ end ### Alicloud Permissions -{{% alicloud_principal_action action="ecs:DescribeDisks" %}} +{{% inspec-alicloud/alicloud_principal_action action="ecs:DescribeDisks" %}} -{{% alibaba_access_management_doc %}} -{{% alibaba_authentication_ecs_api_doc %}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ecs_api_doc.md" >}} diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ecs_instance.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ecs_instance.md index 8053b2718f..b16c0d097b 100644 --- a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ecs_instance.md +++ b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ecs_instance.md @@ -159,7 +159,7 @@ end ## Matchers -{{% inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### exist @@ -179,5 +179,5 @@ it { should_not exist } Your Principal will need the `ecs:DescribeInstances`, `ecs:DescribeInstanceAttribute` and `ecs:DescribeInstanceRamRole` actions with Effect set to Allow. -{{% alibaba_access_management_doc %}} -{{% alibaba_authentication_ecs_api_doc %}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ecs_api_doc.md" >}} diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ecs_instances.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ecs_instances.md index 73db974603..37c41f92dc 100644 --- a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ecs_instances.md +++ b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ecs_instances.md @@ -191,7 +191,7 @@ end ## Matchers -{{% inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### exist @@ -215,5 +215,5 @@ end Your Principal will need the `ecs:DescribeInstances` and `ecs:DescribeInstanceRamRole` actions with Effect set to Allow. -{{% alibaba_access_management_doc %}} -{{% alibaba_authentication_ecs_api_doc %}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ecs_api_doc.md" >}} diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ims_user.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ims_user.md new file mode 100644 index 0000000000..41b5bd3371 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ims_user.md @@ -0,0 +1,112 @@ ++++ +title = "alicloud_ims_user Resource" +platform = "alicloud" +draft = false +gh_repo = "inspec-alicloud" + +[menu.inspec] +title = "alicloud_disk" +identifier = "inspec/resources/alicloud/alicloud_ims_user Resource" +parent = "inspec/resources/alicloud" ++++ + +Use the `alicloud_ims_user` InSpec audit resource to test properties of a single AliCloud IAM User information. + +## Syntax + +**Ensure an user exists** + +```ruby +describe alicloud_ims_user("USER_PRINCIPAL_NAME") do + it { should exist } +end +``` + +**You may also use hash syntax to pass the user principal name** + +```ruby +describe alicloud_ims_user(user_principal_name: "USER_PRINCIPAL_NAME") do + it { should exist } +end +``` + +## Parameters + +This resource accepts a single parameter, `user_principal_name`. + +`user_principal_name` _(required) + +: The user name of the IMS user. + +See also the [Alicloud documentation on cloud disks](https://www.alibabacloud.com/help/doc-detail/25383.htm). + +## Properties + +`status` +: The status of the IAM user. + +`update_date` +: The update date of the IAM user. + +`password_reset_required` +: The password reset required of the IAM user. It accepts boolean value. + +`user_principal_name` +: The user name of the IAM user. + +`mfa_bind_required` +: The mfa bind required of the IAM user. It accepts boolean value. + +## Examples + +**Test that an user does not exist.** + +```ruby +describe alicloud_ims_user("USER_PRINCIPAL_NAME") do + it { should_not exist } +end +``` + +**Test that an user is MFA bind.** + +```ruby +describe alicloud_ims_user("USER_PRINCIPAL_NAME") do + its('mfa_bind_required') { should eq true } +end +``` + +**Test that an user has an `ACTIVE` status.** + +```ruby +describe alicloud_ims_user("USER_PRINCIPAL_NAME") do + its('status') { should eq 'Active' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +### exist + +The control will pass if the describe returns at least one result. + +Use `should` to test the entity should not exist. + +```ruby +describe alicloud_ims_user("USER_PRINCIPAL_NAME") do + it { should exist } +end +``` + +Use `should_not` to test the entity should not exist. + +```ruby +describe alicloud_ims_user("USER_PRINCIPAL_NAME") do + it { should_not exist } +end +``` + +### Alicloud Permissions + +{{% inspec-alicloud/alicloud_principal_action action="ims:GetLoginProfile" %}} diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_policies.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_policies.md index e72a56dc2f..c7910ad042 100644 --- a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_policies.md +++ b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_policies.md @@ -109,5 +109,5 @@ end Your Principal will need the `ram:ListPolicies` and `ram:ListEntitiesForPolicy` actions with Effect set to Allow. -{{% alibaba_access_management_doc %}} -{{% alibaba_authentication_ram_api_doc %}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ram_api_doc.md" >}} diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_policy.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_policy.md index c8d7d96706..54e63c7b6d 100644 --- a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_policy.md +++ b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_policy.md @@ -158,7 +158,7 @@ its('attachment_count') { should be eq 7 } This InSpec audit resource has the following special matchers. -{{% inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### exist @@ -297,5 +297,5 @@ it { should have_statement(Resource: /acs:oss.+:(sally|kim)/) } Your Principal will need the `ram:GetPolicy` and `ram:ListEntitiesForPolicy` actions with Effect set to Allow. -{{% alibaba_access_management_doc %}} -{{% alibaba_authentication_ram_api_doc %}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ram_api_doc.md" >}} diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_user.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_user.md index cfa5da73cd..7a4ef95358 100644 --- a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_user.md +++ b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_user.md @@ -106,7 +106,7 @@ end ## Matchers -{{% inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### exist @@ -142,5 +142,5 @@ This will check whether the requested user has a login profile for console acces Your Principal will need the following permissions action with Effect set to Allow: `ram:Getuser`, `ram:GetLoginProfile`, `ram:ListAccessKeys`. -{{% alibaba_access_management_doc %}} -{{% alibaba_authentication_ram_api_doc %}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ram_api_doc.md" >}} diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_user_mfa.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_user_mfa.md index 9e6b2ce6d3..5131e0c12f 100644 --- a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_user_mfa.md +++ b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_user_mfa.md @@ -58,7 +58,7 @@ end ## Matchers -{{% inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### exist @@ -76,7 +76,7 @@ it { should_not exist } ### Alicloud Permissions -{{% alicloud_principal_action action="ram:GetUserMFAInfo" %}} +{{% inspec-alicloud/alicloud_principal_action action="ram:GetUserMFAInfo" %}} -{{% alibaba_access_management_doc %}} -{{% alibaba_authentication_ram_api_doc %}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ram_api_doc.md" >}} diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_users.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_users.md index 05afbd2003..a734f4719e 100644 --- a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_users.md +++ b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/alicloud_ram_users.md @@ -139,5 +139,5 @@ end Your Principal will need the following permissions action with Effect set to Allow: `ram:Listusers`, `ram:GetLoginProfile`, `ram:ListAccessKeys`, `ram:GetUserMFAInfo` -{{% alibaba_access_management_doc %}} -{{% alibaba_authentication_ram_api_doc %}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_access_management_doc.md" >}} +{{< readfile file="content/inspec/resources/reusable/md/alibaba_authentication_ram_api_doc.md" >}} diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/reusable/index.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/reusable/index.md new file mode 100644 index 0000000000..41de90ae49 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/reusable/index.md @@ -0,0 +1,5 @@ ++++ +headless = true +## headless = true makes this directory a headless bundle. +## See https://gohugo.io/content-management/page-bundles/#headless-bundle ++++ diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/layouts/shortcodes/alibaba_access_management_doc.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/reusable/md/alibaba_access_management_doc.md similarity index 100% rename from _vendor/github.com/inspec/inspec-alicloud/docs-chef-io/layouts/shortcodes/alibaba_access_management_doc.md rename to _vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/reusable/md/alibaba_access_management_doc.md diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/layouts/shortcodes/alibaba_authentication_ecs_api_doc.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/reusable/md/alibaba_authentication_ecs_api_doc.md similarity index 100% rename from _vendor/github.com/inspec/inspec-alicloud/docs-chef-io/layouts/shortcodes/alibaba_authentication_ecs_api_doc.md rename to _vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/reusable/md/alibaba_authentication_ecs_api_doc.md diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/layouts/shortcodes/alibaba_authentication_ram_api_doc.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/reusable/md/alibaba_authentication_ram_api_doc.md similarity index 100% rename from _vendor/github.com/inspec/inspec-alicloud/docs-chef-io/layouts/shortcodes/alibaba_authentication_ram_api_doc.md rename to _vendor/github.com/inspec/inspec-alicloud/docs-chef-io/content/inspec/resources/reusable/md/alibaba_authentication_ram_api_doc.md diff --git a/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/layouts/shortcodes/alicloud_principal_action.md b/_vendor/github.com/inspec/inspec-alicloud/docs-chef-io/layouts/shortcodes/inspec-alicloud/alicloud_principal_action.md similarity index 100% rename from _vendor/github.com/inspec/inspec-alicloud/docs-chef-io/layouts/shortcodes/alicloud_principal_action.md rename to _vendor/github.com/inspec/inspec-alicloud/docs-chef-io/layouts/shortcodes/inspec-alicloud/alicloud_principal_action.md diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_alb.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_alb.md index 5f23278717..765ddc8746 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_alb.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_alb.md @@ -14,9 +14,9 @@ Use the `aws_alb` InSpec audit resource to test properties of a single AWS Appli For additional information, including details on parameters and properties, see the [AWS documentation on Elastic Load Balancing](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -117,7 +117,9 @@ end ## Matchers -This InSpec audit resource has no special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -139,6 +141,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeLoadBalancers" %}} +{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeLoadBalancers" %}} You can find detailed documentation at [Authentication and Access Control for Your Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/load-balancer-authentication-access-control.html) diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_albs.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_albs.md index c00f2f8f0f..9596d9b8de 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_albs.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_albs.md @@ -14,9 +14,9 @@ Use the `aws_albs` InSpec audit resource to test the configuration of a collecti For additional information, including details on parameters and properties, see the [AWS documentation on Elastic Load Balancing](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -84,7 +84,9 @@ end ## Matchers -This InSpec audit resource has no special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -101,6 +103,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeLoadBalancers" %}} +{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeLoadBalancers" %}} You can find detailed documentation at [Authentication and Access Control for Your Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/load-balancer-authentication-access-control.html) diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ami.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ami.md index d299884272..95b5edc459 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ami.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ami.md @@ -14,9 +14,9 @@ Use the `aws_ami` InSpec audit resource to test properties of a single AWS AMI. For additional information, including details on parameters and properties, see the [AWS documentation on EC2 Amazon Machine Images](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -129,7 +129,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### be_public @@ -167,6 +169,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeImages" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeImages" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amis.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amis.md index 0eda9c04f6..fcb4af4def 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amis.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amis.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_amis` InSpec audit resource to test properties of some or all AWS AMIs. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -190,7 +190,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -212,6 +214,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeImages" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeImages" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_app.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_app.md index c2672a7053..f5d1c1a682 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_app.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_app.md @@ -14,9 +14,9 @@ Use the `aws_amplify_app` InSpec audit resource to test the properties of a sing For additional information, including details on parameters and properties, see the [AWS documentation on AWS Amplify App](https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -98,9 +98,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -132,4 +132,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Amplify:Client:GetAppResult" %}} +{{% inspec-aws/aws_permissions_principal action="Amplify:Client:GetAppResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_apps.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_apps.md index 0c51411b39..9f7ec4b48a 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_apps.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_apps.md @@ -14,9 +14,9 @@ Use the `aws_amplify_apps` InSpec audit resource to test the properties of Multi For additional information, including details on parameters and properties, see the [AWS documentation on AWS Amplify App](https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -125,7 +125,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `List` method returns at least one result. @@ -159,4 +159,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Amplify:Client:ListAppsResult" %}} +{{% inspec-aws/aws_permissions_principal action="Amplify:Client:ListAppsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_branch.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_branch.md index 615906a388..b1ddbadcfd 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_branch.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_branch.md @@ -14,9 +14,9 @@ Use the `aws_amplify_branch` InSpec audit resource to test the properties of a s For additional information, including details on parameters and properties, see the [AWS documentation on AWS Amplify Branch](https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -102,9 +102,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -136,4 +136,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Amplify:Client:GetBranchResult" %}} +{{% inspec-aws/aws_permissions_principal action="Amplify:Client:GetBranchResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_branches.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_branches.md index 9ed8aaa75b..468bc96e15 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_branches.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_amplify_branches.md @@ -14,9 +14,9 @@ Use the `aws_amplify_branches` InSpec audit resource to test the properties of m For additional information, including details on parameters and properties, see the [AWS documentation on AWS Amplify branch](https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -126,7 +126,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -160,4 +160,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Amplify:Client:ListBranchesResult" %}} +{{% inspec-aws/aws_permissions_principal action="Amplify:Client:ListBranchesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_deployment.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_deployment.md index 38552ce1ad..955cffa007 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_deployment.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_deployment.md @@ -16,9 +16,9 @@ The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource For additional information, including details on parameters and properties, see the [AWS ApiGateway Deployment documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -80,9 +80,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -114,4 +114,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:Deployment" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:Deployment" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_deployments.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_deployments.md index 299c23066d..f71ef9b353 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_deployments.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_deployments.md @@ -16,9 +16,9 @@ The AWS::ApiGateway::Deployment resource deploys an API Gateway RestAPI resource For additional information, including details on parameters and properties, see the [AWS ApiGateway Deployment documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -60,9 +60,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -94,4 +94,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client::Deployments" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client::Deployments" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_part.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_part.md index bb36509a43..3f0c8ec3ad 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_part.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_part.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::DocumentationPart` resource creates a documentation part f For additional information, including details on parameters and properties, see the [AWS ApiGateway Documentation Part](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -83,9 +83,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -117,4 +117,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:DocumentationPart" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:DocumentationPart" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_parts.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_parts.md index 1e10a63d9f..0681a03d57 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_parts.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_parts.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::DocumentationParts` resource creates a documentation part For additional information, including details on parameters and properties, see the [AWS ApiGateway Documentation Part documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -71,9 +71,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -105,4 +105,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client::DocumentationParts" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client::DocumentationParts" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_version.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_version.md index fb6501e1c8..8970c5458d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_version.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_version.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::DocumentationVersion` resource creates a documentation ver For additional information, including details on parameters and properties, see the [AWS ApiGateway documentation version documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -71,9 +71,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -105,4 +105,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:DocumentationVersion" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:DocumentationVersion" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_versions.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_versions.md index 36f319ed82..bf84e27cc6 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_versions.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_versions.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::DocumentationParts` resource creates a documentation versi For additional information, including details on parameters and properties, see the [AWS ApiGateway Documentation Version documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -63,9 +63,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -97,4 +97,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client::DocumentationVersions" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client::DocumentationVersions" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_domain_name.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_domain_name.md new file mode 100644 index 0000000000..bdb184e743 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_domain_name.md @@ -0,0 +1,190 @@ ++++ +title = "aws_api_gateway_domain_name resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_domain_name" +identifier = "inspec/resources/aws/aws_api_gateway_domain_name resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_domain_name` InSpec audit resource to test the properties of a single specific AWS API Gateway domain name. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGateway DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the domain name exists. + +```ruby +describe aws_api_gateway_domain_name(domain_name: 'DOMAIN_NAME') do + it { should exist } +end +``` + +## Parameters + +`domain_name` _(required)_ +: The custom domain name as an API hostname. For example, my-api.example.com. + +## Properties + +`domain_name` +: The custom domain name as an API hostname. For example, my-api.example.com. + +: **Field**: `domain_name` + +`certificate_name` +: The certificate name used by the edge-optimized endpoint for this domain name. + +: **Field**: `certificate_name` + +`certificate_arn` +: The reference to an AWS-managed certificate for use by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source. + +: **Field**: `certificate_arn` + +`certificate_upload_date` +: The timestamp when the certificate used by the edge-optimized endpoint for this domain name is uploaded. + +: **Field**: `certificate_upload_date` + +`regional_domain_name` +: The domain name associated with the regional endpoint for this custom domain name. You can set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when creating a regional endpoint. + +: **Field**: `regional_domain_name` + +`regional_hosted_zone_id` +: The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see [Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html). + +: **Field**: `regional_hosted_zone_id` + +`regional_certificate_name` +: The certificate name used for validating the regional domain name. + +: **Field**: `regional_certificate_name` + +`regional_certificate_arn` +: The reference to an AWS-managed certificate that is used to validate the regional domain name. AWS Certificate Manager is the only supported source. + +: **Field**: `regional_certificate_arn` + +`distribution_domain_name` +: The Amazon CloudFront distribution domain name associated with this custom domain name for an edge-optimized endpoint. You can set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the [Amazon CloudFront documentation](https://docs.aws.amazon.com/cloudfront/index.html). + +: **Field**: `distribution_domain_name` + +`distribution_hosted_zone_id` +: The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is `Z2FDTNDATAQYW2` for all the regions. + +: **Field**: `distribution_hosted_zone_id` + +`endpoint_configuration_types` +: A list of the endpoint types of the domain name. The valid values are `EDGE` for edge-optimized API setup, most suitable for mobile applications; `REGIONAL` for regional API endpoint setup, most suitable for calling from AWS Region; and `PRIVATE` for private APIs. + +: **Field**: `endpoint_configuration.types` + +`endpoint_configuration_vpc_endpoint_ids` +: A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for the `PRIVATE` endpoint type. + +: **Field**: `endpoint_configuration.vpc_endpoint_ids` + +`domain_name_status` +: The status of the domain name migration. The valid values are `AVAILABLE` and `UPDATING`. If the status is `UPDATING`, the domain cannot be modified further until the existing operation is complete. If it is `AVAILABLE`, the domain can be updated. + +: **Field**: `domain_name_status` + +`domain_name_status_message` +: An optional text message containing detailed information about the status of the domain name migration. + +: **Field**: `domain_name_status_message` + +`security_policy` +: The Transport Layer Security (TLS) version and cipher suite for this domain name. The valid values are `TLS_1_0` and `TLS_1_2`. + +: **Field**: `security_policy` + +`tags` +: The collection of tags. + +: **Field**: `tags` + +`mutual_tls_authentication.truststore_uri` +: An Amazon S3 URL that specifies the truststore for mutual TLS authentication. For example, `s3://bucket-name/key-name`. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3 and update your custom domain name to use the new version. To update the truststore, you must have permission to access the S3 object. + +: **Field**: `mutual_tls_authentication.truststore_uri` + +`mutual_tls_authentication.truststore_version` +: The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket. + +: **Field**: `mutual_tls_authentication.truststore_version` + +`mutual_tls_authentication_truststore_warnings` +: A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3 and update your domain name to use the new version. + +: **Field**: `mutual_tls_authentication.truststore_warnings` + +`ownership_verification_certificate_arn` +: The ARN of the public certificate issued by ACM to validate ownership of your custom domain. + +: **Field**: `ownership_verification_certificate_arn` + +## Examples + +### Test to ensure the domain name is available + +```ruby +describe aws_api_gateway_domain_name(domain_name: 'DOMAIN_NAME') do + its('domain_name') { should eq 'DOMAIN_NAME' } +end +``` + +### Test to ensure a regional hosted zone ID is available + +```ruby +describe aws_api_gateway_domain_name(domain_name: 'DOMAIN_NAME') do + its('regional_hosted_zone_id') { should eq 'REGIONAL_HOSTED_ZONE_ID' } +end +``` + +### Test to ensure the domain name status is `AVAILABLE` + +```ruby +describe aws_api_gateway_domain_name(domain_name: 'DOMAIN_NAME') do + its('domain_name_status') { should eq 'AVAILABLE' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_domain_name(domain_name: 'DOMAIN_NAME') do + it { should exist } +end +``` + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_domain_name(domain_name: 'DOMAIN_NAME') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:DomainName" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_domain_names.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_domain_names.md new file mode 100644 index 0000000000..ed4c73a810 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_domain_names.md @@ -0,0 +1,174 @@ ++++ +title = "aws_api_gateway_domain_names resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_domain_names" +identifier = "inspec/resources/aws/aws_api_gateway_domain_names resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_domain_names` InSpec audit resource to test the properties of multiple AWS API Gateway domain names. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGateway DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the domain name exists. + +```ruby +describe aws_api_gateway_domain_names do + it { should exist } +end +``` + +## Parameters + +This resource does not require any parameters. + +## Properties + +`domain_names` +: The custom domain name as an API hostname. For example, my-api.example.com. + +: **Field**: `domain_name` + +`certificate_names` +: The certificate name used by the edge-optimized endpoint for this domain name. + +: **Field**: `certificate_name` + +`certificate_arns` +: The reference to an AWS-managed certificate that is used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source. + +: **Field**: `certificate_arn` + +`certificate_upload_dates` +: The timestamp when the certificate used by the edge-optimized endpoint for this domain name is uploaded. + +: **Field**: `certificate_upload_date` + +`regional_domain_names` +: The domain name associated with the regional endpoint for this custom domain name. You can set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when creating a regional endpoint. + +: **Field**: `regional_domain_name` + +`regional_hosted_zone_ids` +: The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see [Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html). + +: **Field**: `regional_hosted_zone_id` + +`regional_certificate_names` +: The certificate name used for validating the regional domain name. + +: **Field**: `regional_certificate_name` + +`regional_certificate_arns` +: The reference to an AWS-managed certificate used to validate the regional domain name. AWS Certificate Manager is the only supported source. + +: **Field**: `regional_certificate_arn` + +`distribution_domain_names` +: The Amazon CloudFront distribution domain name associated with this custom domain name for an edge-optimized endpoint. You can set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the [Amazon CloudFront documentation](https://docs.aws.amazon.com/cloudfront/index.html). + +: **Field**: `distribution_domain_name` + +`distribution_hosted_zone_ids` +: The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. + +: **Field**: `distribution_hosted_zone_id` + +`endpoint_configurations` +: The endpoint configuration of the domain name showing the endpoint types of the domain name. + +: **Field**: `endpoint_configuration` + +`domain_name_statuses` +: The status of the domain name migration. The valid values are `AVAILABLE` and `UPDATING`. If the status is `UPDATING`, the domain cannot be modified further until the existing operation is complete. If it is `AVAILABLE`, the domain can be updated. + +: **Field**: `domain_name_status` + +`domain_name_status_messages` +: An optional text message containing detailed information about the status of the domain name migration. + +: **Field**: `domain_name_status_message` + +`security_policies` +: The Transport Layer Security (TLS) version and cipher suite for this domain name. The valid values are `TLS_1_0` and `TLS_1_2`. + +: **Field**: `security_policy` + +`tags` +: The collection of tags. + +: **Field**: `tags` + +`mutual_tls_authentications` +: The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API. + +: **Field**: `mutual_tls_authentication` + +`ownership_verification_certificate_arns` +: The ARN of the public certificate issued by ACM to validate ownership of your custom domain. + +: **Field**: `ownership_verification_certificate_arn` + +## Examples + +### Test to ensure the domain name is available + +```ruby +describe aws_api_gateway_domain_names do + its('domain_names') { should include 'DOMAIN_NAME' } +end +``` + +### Test to ensure a regional hosted zone ID is available + +```ruby +describe aws_api_gateway_domain_names do + its('regional_hosted_zone_ids') { should include 'REGIONAL_HOSTED_ZONE_ID' } +end +``` + +### Test to ensure that the domain name status includes `AVAILABLE` + +```ruby +describe aws_api_gateway_domain_names do + its('domain_name_statuses') { should include 'AVAILABLE' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_domain_names do + it { should exist } +end +``` + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_domain_names do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:DomainNames" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_method.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_method.md index 37c774396f..0ac880735d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_method.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_method.md @@ -16,9 +16,9 @@ The AWS::ApiGateway::Method resource creates API Gateway methods that define the For additional information, including details on parameters and properties, see the [AWS APIGateway Method documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -159,9 +159,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -193,4 +193,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client::client:Method" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client::client:Method" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_methods.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_methods.md index 5f3720c864..46033dc905 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_methods.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_methods.md @@ -16,9 +16,9 @@ The AWS::ApiGateway::Method resource creates API Gateway methods that define the For additional information, including details on parameters and properties, see the [AWS APIGateway Method documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -91,9 +91,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -125,4 +125,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:Methods" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:Methods" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_model.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_model.md index f2b201a459..fc099a7526 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_model.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_model.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::Model` resource defines the structure of a request or resp For additional information, including details on parameters and properties, see the [AWS documentation on `AWS::APIGateway::Model` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -93,9 +93,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -117,4 +117,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ApiGateway:Client:Model" %}} +{{% inspec-aws/aws_permissions_principal action="ApiGateway:Client:Model" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_models.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_models.md index 621c6d2f9c..4a2d021aaa 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_models.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_models.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::Model` resource defines the structure of a request or resp For additional information, including details on parameters and properties, see the [AWS documentation on `AWS::APIGateway::Model` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -99,9 +99,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -123,4 +123,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ApiGateway:Client:Models" %}} +{{% inspec-aws/aws_permissions_principal action="ApiGateway:Client:Models" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_request_validator.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_request_validator.md new file mode 100644 index 0000000000..81c575c2db --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_request_validator.md @@ -0,0 +1,101 @@ ++++ +title = "aws_api_gateway_request_validator Resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_request_validator" +identifier = "inspec/resources/aws/aws_api_gateway_request_validator Resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_request_validator` InSpec audit resource to test the properties of a single API Gateway request validator. + +The AWS::ApiGateway::RequestValidator resource sets up basic validation rules for incoming integration requests to your API. + +For additional information, including details on parameters and properties, see the [AWS APIGateway RequestValidator documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that an API Gateway request validator exists. + +```ruby +describe aws_api_gateway_request_validator(rest_api_id: 'API_ID', request_validator_id: 'API_REQUEST_ID') do + it { should exist } +end +``` + +## Parameters + +`rest_api_id` _(required)_ + +: The string identifier of the associated RestApi entity. + +`request_validator_id` _(required)_ + +: The identifier of the RequestValidator to be retrieved. + +## Properties + +`id` +: The identifier of this RequestValidator. + +`name` +: The name of this RequestValidator. + +`validate_request_body` +: A Boolean flag to indicate whether to validate a request body according to the configured model schema for the method (`true`) or not (`false`). + +`validate_request_parameters` +: A Boolean flag to indicate whether to validate request parameters (`true`) or not (`false`). + +## Examples + +### Test to ensure a request validator ID is present + +```ruby +describe aws_api_gateway_request_validator(rest_api_id: 'API_ID', request_validator_id: 'API_REQUEST_ID') do + its('id') { should eq 'REQUEST_ID' } +end +``` + +### Test to ensure that the request body is 'true' + +```ruby +describe aws_api_gateway_request_validator(rest_api_id: 'API_ID', request_validator_id: 'API_REQUEST_ID') do + its('validate_request_body') { should eq true } +end +``` + +## Matchers + +This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_request_validator(rest_api_id: 'API_ID', request_validator_id: 'API_REQUEST_ID') do + it { should exist } +end +``` + +Use `should_not` to test the entity does not exist. + +```ruby +describe aws_api_gateway_request_validator(rest_api_id: 'API_ID', request_validator_id: 'API_REQUEST_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:RequestValidator" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_request_validators.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_request_validators.md new file mode 100644 index 0000000000..9d2d191ac9 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_request_validators.md @@ -0,0 +1,115 @@ ++++ +title = "aws_api_gateway_request_validators Resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_request_validators" +identifier = "inspec/resources/aws/aws_api_gateway_request_validators Resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_request_validators` Chef InSpec audit resource to the test properties of multiple AWS API Gateway request validators. + +The AWS::ApiGateway::RequestValidator resource sets up basic validation rules for incoming requests to your API. + +For additional information, including details on parameters and properties, see the [AWS APIGateway RequestValidator documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that an API Gateway request validator exists. + +```ruby +describe aws_api_gateway_request_validators(rest_api_id: 'API_ID') do + it { should exist } +end +``` + +## Parameters + +`rest_api_id` _(required)_ + +: The string identifier of the associated RestApi. + +## Properties + +`id` +: The identifier of this RequestValidator. + +: **Field**: `id` + +`name` +: The name of this RequestValidator. + +: **Field**: `name` + +`validate_request_body` +: A Boolean flag to indicate whether to validate a request body according to the configured model schema. + +: **Field**: `validate_request_body` + +`validate_request_parameters` +: A Boolean flag to indicate whether to validate request parameters (`true`) or not (`false`). + +: **Field**: `validate_request_parameters` + +## Examples + +### Test to ensure a request validator ID is present + +```ruby +describe aws_api_gateway_request_validators(rest_api_id: 'API_ID') do + its('ids') { should include 'REQUEST_ID' } +end +``` + +### Test to ensure the request body is 'true' + +```ruby +describe aws_api_gateway_request_validators(rest_api_id: 'API_ID') do + its('validate_request_bodies') { should include true } +end +``` + +## Matchers + +This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_method(rest_api_id: 'API_ID', resource_id: 'RESOURCE_ID', http_method: 'HTTP') do + it { should exist } +end +``` + +Use `should_not` to test the entity does not exist. + +```ruby +describe aws_api_gateway_method(rest_api_id: 'API_ID', resource_id: 'RESOURCE_ID', http_method: 'HTTP') do + it { should_not exist } +end +``` + +### be_available + +Use `should` to check if the work_group name is available. + +```ruby +describe aws_api_gateway_method(rest_api_id: 'API_ID', resource_id: 'RESOURCE_ID', http_method: 'HTTP') do + it { should be_available } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:RequestValidators" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_resource.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_resource.md new file mode 100644 index 0000000000..c8530f4d14 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_resource.md @@ -0,0 +1,120 @@ ++++ +title = "aws_api_gateway_resource resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_resource" +identifier = "inspec/resources/aws/aws_api_gateway_resource resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_resource` InSpec audit resource to test the properties of a single specific AWS API Gateway Resource. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGateway Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the resource exists. + +```ruby +describe aws_api_gateway_resource(rest_api_id: 'REST_API_ID', resource_id: 'RESOURCE_ID') do + it { should exist } +end +``` + +## Parameters + +`rest_api_id` _(required)_ + +: The string identifier of the associated RestApi. + +`resource_id` _(required)_ + +: The identifier for the Resource resource. + +## Properties + +`id` +: The resource's identifier. + +: **Field**: `id` + +`parent_id` +: The parent resource's identifier. + +: **Field**: `parent_id` + +`path_part` +: The last path segment for this resource. + +: **Field**: `path_part` + +`path` +: The full path for this resource. + +: **Field**: `path` + +`resource_methods` +: Gets an API resource's method of a given HTTP verb. + +: **Field**: `resource_methods` + +## Examples + +### Test to ensure a resource ID is available + +```ruby +describe aws_api_gateway_resource(rest_api_id: 'REST_API_ID', resource_id: 'RESOURCE_ID') do + its('id') { should eq 'RESOURCE_ID' } +end +``` + +### Test to ensure a resource path is available + +```ruby +describe aws_api_gateway_resource(rest_api_id: 'REST_API_ID', resource_id: 'RESOURCE_ID') do + its('path') { should eq '/' } +end +``` + +### Test to ensure a resource parent ID is available + +```ruby +describe aws_api_gateway_resource(rest_api_id: 'REST_API_ID', resource_id: 'RESOURCE_ID') do + its('parent_id') { should eq 'PARENT_ID' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_resource(rest_api_id: 'REST_API_ID', resource_id: 'RESOURCE_ID') do + it { should exist } +end +``` + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_resource(rest_api_id: 'REST_API_ID', resource_id: 'RESOURCE_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:Resource" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_resources.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_resources.md new file mode 100644 index 0000000000..52d6e3e200 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_resources.md @@ -0,0 +1,116 @@ ++++ +title = "aws_api_gateway_resources Resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_resources" +identifier = "inspec/resources/aws/aws_api_gateway_resources Resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_resources` Chef InSpec audit resource to test the properties of multiple AWS API Gateway Resources. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGateway Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the resource exists. + +```ruby +describe aws_api_gateway_resources(rest_api_id: 'REST_API_ID') do + it { should exist } +end +``` + +## Parameters + +`rest_api_id` _(required)_ + +: The string identifier of the associated RestApi. + +## Properties + +`ids` +: The resource's identifier. + +: **Field**: `id` + +`parent_ids` +: The parent resource's identifier. + +: **Field**: `parent_id` + +`path_parts` +: The last path segment for this resource. + +: **Field**: `path_part` + +`paths` +: The full path for this resource. + +: **Field**: `path` + +`resource_methods` +: Gets an API resource's method of a given HTTP verb. + +: **Field**: `resource_methods` + +## Examples + +### Test to ensure the resource is present + +```ruby +describe aws_api_gateway_resources(rest_api_id: 'REST_API_ID') do + its('ids') { should include 'RESOURCE_ID' } +end +``` + +### Test to ensure the parent ID is present + +```ruby +describe aws_api_gateway_resources(rest_api_id: 'REST_API_ID') do + its('parent_ids') { should include 'PARENT_ID' } +end +``` + +### Test to ensure the path includes `/` + +```ruby +describe aws_api_gateway_resources(rest_api_id: 'REST_API_ID') do + its('paths') { should include "/" } +end +``` + +## Matchers + +This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_resources(rest_api_id: 'REST_API_ID') do + it { should exist } +end +``` + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_resources(rest_api_id: 'REST_API_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:Resources" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_response.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_response.md index 62e78237d8..e1a2f14390 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_response.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_response.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::GatewayResponse` resource creates a gateway response for y For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::APIGateway::GatewayResponse` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -77,9 +77,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -101,4 +101,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:GatewayResponse" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:GatewayResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_responses.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_responses.md index 1bc0cfa278..f3ee3de248 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_responses.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_responses.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::GatewayResponse` resource creates a gateway response for y For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::APIGateway::GatewayResponse` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -83,9 +83,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -107,4 +107,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:GatewayResponses" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:GatewayResponses" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_restapi.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_restapi.md index 3fe2d68123..28cc9930b3 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_restapi.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_restapi.md @@ -16,9 +16,9 @@ The AWS::ApiGateway::RestApi resource creates a REST API. For additional information, including details on parameters and properties, see the [AWS API Gateway REST API documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -98,9 +98,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -132,4 +132,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:RestApi" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:RestApi" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_restapis.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_restapis.md index fe107cd956..47042cf53f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_restapis.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_restapis.md @@ -16,9 +16,9 @@ The AWS::ApiGateway::RestApi resource creates a REST API. For additional information, including details on parameters and properties, see the [AWS API Gateway REST API documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -95,9 +95,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -111,4 +111,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:RestApis" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:RestApis" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_stage.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_stage.md index fba2dd6b3c..ceaefbfdaa 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_stage.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_stage.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::Stage` resource deploys an API Gateway REST API resource t For additional information, including details on parameters and properties, see the [AWS API Gateway stage documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -155,9 +155,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -189,4 +189,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:Stage" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:Stage" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_stages.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_stages.md index af4ddd8676..0d539ec552 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_stages.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_stages.md @@ -16,9 +16,9 @@ The 'AWS::ApiGateway::Stage' resource deploys an API Gateway REST API resource t For additional information, including details on parameters and properties, see the [AWS API Gateway stage Stage documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -62,9 +62,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -96,4 +96,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client::Stages" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client::Stages" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plan.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plan.md new file mode 100644 index 0000000000..fbe2ba7192 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plan.md @@ -0,0 +1,170 @@ ++++ +title = "aws_api_gateway_usage_plan resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_usage_plan" +identifier = "inspec/resources/aws/aws_api_gateway_usage_plan resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_usage_plan` InSpec audit resource to test the properties of a single specific AWS API Gateway usage plan. A usage plan sets a target for the throttling and quota limits on individual client API keys. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGateway UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that a usage plan exists. + +```ruby +describe aws_api_gateway_usage_plan(usage_plan_id: 'USAGE_PLAN_ID') do + it { should exist } +end +``` + +## Parameters + +`usage_plan_id` _(required)_ +: The identifier of a usage plan resource. + +## Properties + +`id` +: The identifier of a usage plan resource. + +: **Field**: `id` + +`name` +: The name of a usage plan. + +: **Field**: `name` + +`description` +: The description of a usage plan. + +: **Field**: `description` + +`api_stages` +: The associated API stages of a usage plan. + +: **Field**: `api_stages` + +`api_stages_api_ids` +: API ID of the associated API stage in a usage plan. + +: **Field**: `api_stages[0].api_id` + +`api_stages_stages` +: API stage name of the associated API stage in a usage plan. + +: **Field**: `api_stages[0].stage` + +`api_stages_throttles` +: Map containing method level throttling information for API stage in a usage plan. + +: **Field**: `api_stages[0].throttle` + +`throttle` +: The overall request rate (average requests per second) and burst capacity. A map containing method level throttling information for the API stage in a usage plan. + +: **Field**: `throttle` + +`throttle.burst_limit` +: The API target request burst rate limit. This allows more requests for a period of time than the target rate limit. + +: **Field**: `throttle.burst_limit` + +`throttle.rate_limit` +: The API target request rate limit. + +: **Field**: `throttle.rate_limit` + +`quota` +: The maximum target number of permitted requests that the user can make within a given time interval. + +: **Field**: `quota` + +`quota.limit` +: The target maximum number of requests that can be made in a given time period. + +: **Field**: `quota.limit` + +`quota.offset` +: The number of requests subtracted from the given limit in the initial time period. + +: **Field**: `quota.offset` + +`quota.period` +: The time period in which the limit applies. Valid values are `DAY`, `WEEK`, or `MONTH`. + +: **Field**: `quota.period` + +`product_code` +: The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace. + +: **Field**: `product_code` + +`tags` +: The collection of tags. Each tag element is associated with a given resource. + +: **Field**: `tags` + +## Examples + +### Test to ensure a usage plan ID is available + +```ruby +describe aws_api_gateway_usage_plan(usage_plan_id: 'USAGE_PLAN_ID') do + its('id') { should eq 'USAGE_PLAN_ID' } +end +``` + +### Test to ensure a usage plan name is available + +```ruby +describe aws_api_gateway_usage_plan(usage_plan_id: 'USAGE_PLAN_ID') do + its('name') { should eq 'USAGE_PLAN_NAME' } +end +``` + +### Test to verify the quota limit is set to `2` in the usage plan API gateway + +```ruby +describe aws_api_gateway_usage_plan(usage_plan_id: 'USAGE_PLAN_ID') do + its('quota.limit') { should eq 2 } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_usage_plan(usage_plan_id: 'USAGE_PLAN_ID') do + it { should exist } +end +``` + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_usage_plan(usage_plan_id: 'USAGE_PLAN_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:UsagePlan" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plan_key.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plan_key.md new file mode 100644 index 0000000000..86ae4386c0 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plan_key.md @@ -0,0 +1,99 @@ ++++ +title = "aws_api_gateway_usage_plan_key resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_usage_plan_key" +identifier = "inspec/resources/aws/aws_api_gateway_usage_plan_key resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_usage_plan_key` InSpec audit resource to test the properties of a specific AWS API Gateway usage plan key. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGateway UsagePlanKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that a usage plan key exists. + +```ruby +describe aws_api_gateway_usage_plan_key(usage_plan_id: 'USAGE_PLAN_ID', key_id: 'USAGE_PLAN_KEY_ID') do + it { should exist } +end +``` + +## Parameters + +`usage_plan_id` _(required)_ + +: The usage plan resource ID represents the usage plan containing the to-be-retrieved usage plan's key resource and a plan customer. + +`key_id` _(required)_ + +: The key ID of the to-be-retrieved usage plan key resource representing a plan customer. + +## Properties + +`id` +: The usage plan key ID. + +`type` +: The usage plan key type. Currently, the valid key type is `API_KEY`. + +`value` +: The value of a usage plan key. + +`name` +: The usage plan key name. + +## Examples + +### Test to ensure a usage plan key ID is available + +```ruby +describe aws_api_gateway_usage_plan_key(usage_plan_id: 'USAGE_PLAN_ID', key_id: 'USAGE_PLAN_KEY_ID') do + its('id') { should eq 'USAGE_PLAN_KEY_ID' } +end +``` + +### Test to ensure a usage plan key name is available + +```ruby +describe aws_api_gateway_usage_plan_key(usage_plan_id: 'USAGE_PLAN_ID', key_id: 'USAGE_PLAN_KEY_ID') do + its('name') { should eq 'USAGE_PLAN_KEY_NAME' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_usage_plan(usage_plan_id: 'USAGE_PLAN_ID') do + it { should exist } +end +``` + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_usage_plan(usage_plan_id: 'USAGE_PLAN_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:UsagePlanKey" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plan_keys.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plan_keys.md new file mode 100644 index 0000000000..7b6d588f4c --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plan_keys.md @@ -0,0 +1,103 @@ ++++ +title = "aws_api_gateway_usage_plan_keys resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_usage_plan_keys" +identifier = "inspec/resources/aws/aws_api_gateway_usage_plan_keys resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_usage_plan_keys` InSpec audit resource to test the properties of multiple AWS API Gateway usage plan keys. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGateway UsagePlanKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the usage plan key exists. + +```ruby +describe aws_api_gateway_usage_plan_keys(usage_plan_id: 'USAGE_PLAN_ID') do + it { should exist } +end +``` + +## Parameters + +`usage_plan_id` _(required)_ + +: The usage plan resource ID represents the usage plan containing the to-be-retrieved usage plan's key resource and a plan customer. + +## Properties + +`ids` +: The usage plan key ID. + +: **Field**: `id` + +`types` +: The usage plan key type. Currently, the valid key type is `API_KEY`. + +: **Field**: `type` + +`values` +: The usage plan key value. + +: **Field**: `value` + +`names` +: The usage plan key name. + +: **Field**: `name` + +## Examples + +### Test to ensure a usage plan key ID is available + +```ruby +describe aws_api_gateway_usage_plan_keys(usage_plan_id: 'USAGE_PLAN_ID') do + its('ids') { should include 'USAGE_PLAN_KEY_ID' } +end +``` + +### Test to ensure a usage plan key name is available + +```ruby +describe aws_api_gateway_usage_plan_keys(usage_plan_id: 'USAGE_PLAN_ID') do + its('names') { should include 'USAGE_PLAN_KEY_NAME' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_usage_plan_keys(usage_plan_id: 'USAGE_PLAN_ID') do + it { should exist } +end +``` + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_usage_plan_keys(usage_plan_id: 'USAGE_PLAN_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:UsagePlanKeys" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plans.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plans.md new file mode 100644 index 0000000000..5d80af01ea --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_usage_plans.md @@ -0,0 +1,121 @@ ++++ +title = "aws_api_gateway_usage_plans resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_usage_plans" +identifier = "inspec/resources/aws/aws_api_gateway_usage_plans resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_usage_plans` InSpec audit resource to test the properties of multiple AWS API Gateway usage plans. A usage plan sets a target for the throttling and quota limits on individual client API keys. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGateway UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the usage plan exists. + +```ruby +describe aws_api_gateway_usage_plans do + it { should exist } +end +``` + +## Parameters + +This resource does not require any parameters. + +## Properties + +`ids` +: The identifier of a usage plan resource. + +: **Field**: `id` + +`names` +: The name of a usage plan. + +: **Field**: `name` + +`descriptions` +: The description of a usage plan. + +: **Field**: `description` + +`api_stages` +: The associated API stages of a usage plan. + +: **Field**: `api_stages` + +`throttles` +: A map containing method level throttling information for the API stage in a usage plan. + +: **Field**: `throttle` + +`quotas` +: The maximum target number of permitted requests that the user can make within a given time interval + +: **Field**: `quota` + +`product_codes` +: The AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace. + +: **Field**: `product_code` + +`tags` +: The collection of tags. Each tag element is associated with a given resource. + +: **Field**: `tags` + +## Examples + +### Test to ensure a usage plan ID is available + +```ruby +describe aws_api_gateway_usage_plans do + its('ids') { should include 'USAGE_PLAN_ID' } +end +``` + +### Test to ensure a usage plan name is available + +```ruby +describe aws_api_gateway_usage_plans do + its('names') { should include 'USAGE_PLAN_NAME' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_usage_plans do + it { should exist } +end +``` + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_usage_plans do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:UsagePlans" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_api.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_api.md new file mode 100644 index 0000000000..52ad8e4b05 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_api.md @@ -0,0 +1,156 @@ ++++ +title = "aws_api_gateway_v2_api resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_api" +identifier = "inspec/resources/aws/aws_api_gateway_v2_api resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_api` InSpec audit resource to test the properties of a single specific AWS API Gateway V2 API. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 API](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the API exists. + +```ruby +describe aws_api_gateway_v2_api(api_id: 'REST_API_ID') do + it { should exist } +end +``` + +## Parameters + +`api_id` _(required)_ +: The API ID. + +## Properties + +`api_endpoint` +: The URI of the API, of the form `{api-id}.execute-api.{region}.amazonaws.com`. The stage name is typically appended to this URI to form a complete path to a deployed API stage. + +`api_gateway_managed` +: Specifies whether an API is managed by API Gateway. You cannot update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it. + +`api_id` +: The API ID. + +`api_key_selection_expression` +: An API key selection expression. Supported only for WebSocket APIs. + +`cors_configuration` +: A CORS configuration. Supported only for HTTP APIs. + +`cors_configuration.allow_credentials` +: Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs. + +`cors_configuration.allow_headers` +: Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs. + +`cors_configuration.allow_methods` +: Represents a collection of allowed HTTP methods. Supported only for HTTP APIs. + +`cors_configuration.allow_origins` +: Represents a collection of allowed origins. Supported only for HTTP APIs. + +`cors_configuration.expose_headers` +: Represents a collection of exposed headers. Supported only for HTTP APIs. + +`cors_configuration.max_age` +: The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs. + +`created_date` +: The timestamp when the API is created. + +`description` +: The description of the API. + +`disable_schema_validation` +: Avoid validating models when creating a deployment. Supported only for WebSocket APIs. + +`disable_execute_api_endpoint` +: Specifies whether clients can invoke your API using the default execute-api endpoint. By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint. + +`import_info` +: The validation information during API import. Supported only for HTTP APIs. + +`name` +: The name of the API. + +`protocol_type` +: The API protocol. Valid values are WEBSOCKET or HTTP. + +`route_selection_expression` +: The route selection expression for the API. For HTTP APIs, the `routeSelectionExpression` must be `${request.method} ${request.path}`. If not provided, this defaults for HTTP APIs. This property is required for WebSocket APIs. + +`tags` +: A collection of tags associated with the API. + +`version` +: A version identifier for the API. + +`warnings` +: The warning messages are reported when `failonwarnings` is turned on during API import. The `failonwarnings` specifies to roll back the API creation when a warning is encountered. By default, API creation continues if a warning is encountered. + +## Examples + +### Test to ensure an API ID is available + +```ruby +describe aws_api_gateway_v2_api(api_id: 'REST_API_ID') do + its('api_id') { should eq 'REST_API_ID' } +end +``` + +### Test to ensure an API name is available + +```ruby +describe aws_api_gateway_v2_api(api_id: 'REST_API_ID') do + its('name') { should eq 'REST_API_NAME' } +end +``` + +### Test to ensure a protocol type is `HTTP` + +```ruby +describe aws_api_gateway_v2_api(api_id: 'REST_API_ID') do + its('protocol_type') { should eq 'HTTP' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_api(api_id: 'REST_API_ID') do + it { should exist } +end +``` + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_api(api_id: 'REST_API_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetApiResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_api_mapping.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_api_mapping.md new file mode 100644 index 0000000000..9e01c98240 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_api_mapping.md @@ -0,0 +1,113 @@ ++++ +title = "aws_api_gateway_v2_api_mapping resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_api_mapping" +identifier = "inspec/resources/aws/aws_api_gateway_v2_api_mapping resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_api_mapping` InSpec audit resource to test the properties of a specific AWS API Gateway V2 API mapping. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 ApiMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that an API mapping exists. + +```ruby +describe aws_api_gateway_v2_api_mapping(api_mapping_id: 'API_MAPPING_ID', domain_name: 'DOMAIN_NAME') do + it { should exist } +end +``` + +## Parameters + +`api_mapping_id` _(required)_ +: The API mapping identifier. + +`domain_name` _(required)_ +: The domain name. + +## Properties + +`api_id` +: The API identifier. + +`api_mapping_id` +: The API mapping identifier. + +`api_mapping_key` +: The API mapping key. + +`stage` +: The API stage. + +## Examples + +### Test to ensure an API ID is available + +```ruby +describe aws_api_gateway_v2_api_mapping(api_mapping_id: 'API_MAPPING_ID', domain_name: 'DOMAIN_NAME') do + its('api_id') { should eq 'REST_API_ID' } +end +``` + +### Test to ensure an API mapping ID is available + +```ruby +describe aws_api_gateway_v2_api_mapping(api_mapping_id: 'API_MAPPING_ID', domain_name: 'DOMAIN_NAME') do + its('api_mapping_id') { should eq 'API_MAPPING_ID' } +end +``` + +### Test to ensure an API mapping key is available + +```ruby +describe aws_api_gateway_v2_api_mapping(api_mapping_id: 'API_MAPPING_ID', domain_name: 'DOMAIN_NAME') do + its('api_mapping_key') { should eq 'API_MAPPING_KEY' } +end +``` + +### Test to ensure an API mapping stage is available + +```ruby +describe aws_api_gateway_v2_api_mapping(api_mapping_id: 'API_MAPPING_ID', domain_name: 'DOMAIN_NAME') do + its('stage') { should eq 'API_STAGE_NAME' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_api_mapping(api_mapping_id: 'API_MAPPING_ID', domain_name: 'DOMAIN_NAME') do + it { should exist } +end +``` + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_api_mapping(api_mapping_id: 'API_MAPPING_ID', domain_name: 'DOMAIN_NAME') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetApiMappingResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_api_mappings.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_api_mappings.md new file mode 100644 index 0000000000..c0d25f54a4 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_api_mappings.md @@ -0,0 +1,118 @@ ++++ +title = "aws_api_gateway_v2_api_mappings Resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_api_mappings" +identifier = "inspec/resources/aws/aws_api_gateway_v2_api_mappings Resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_api_mappings` InSpec audit resource to test the properties of multiple AWS API Gateway V2 API mappings. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 ApiMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure the API mappings exist. + +```ruby +describe aws_api_gateway_v2_api_mappings(domain_name: 'DOMAIN_NAME') do + it { should exist } +end +``` + +## Parameters + +`domain_name` _(required)_ +: The domain name. + +## Properties + +`api_ids` +: The API identifier. + +: **Field**: `api_id` + +`api_mapping_ids` +: The API mapping identifier. + +: **Field**: `api_mapping_id` + +`api_mapping_keys` +: The API mapping key. + +: **Field**: `api_mapping_key` + +`stages` +: The API stage. + +: **Field**: `stage` + +## Examples + +### Test to ensure an API ID is available + +```ruby +describe aws_api_gateway_v2_api_mappings(domain_name: 'DOMAIN_NAME') do + its('api_ids') { should include 'REST_API_ID' } +end +``` + +### Test to ensure an API mapping ID is available + +```ruby +describe aws_api_gateway_v2_api_mappings(domain_name: 'DOMAIN_NAME') do + its('api_mapping_ids') { should include 'API_MAPPING_ID' } +end +``` + +### Test to ensure an API mapping key is available + +```ruby +describe aws_api_gateway_v2_api_mappings(domain_name: 'DOMAIN_NAME') do + its('api_mapping_keys') { should include 'API_MAPPING_KEY' } +end +``` + +### Test to ensure an API mapping stage is available + +```ruby +describe aws_api_gateway_v2_api_mappings(domain_name: 'DOMAIN_NAME') do + its('stages') { should include 'API_STAGE_NAME' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_api_mappings(domain_name: 'DOMAIN_NAME') do + it { should exist } +end +``` + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_api_mappings(domain_name: 'DOMAIN_NAME') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetApiMappingsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_apis.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_apis.md new file mode 100644 index 0000000000..1eca500e3c --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_apis.md @@ -0,0 +1,169 @@ ++++ +title = "aws_api_gateway_v2_apis Resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_apis" +identifier = "inspec/resources/aws/aws_api_gateway_v2_apis Resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_apis` InSpec audit resource to test properties of multiple AWS API Gateway V2 APIs. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 API](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure the API exists. + +```ruby +describe aws_api_gateway_v2_apis do + it { should exist } +end +``` + +## Parameters + +This resource does not require any parameters. + +## Properties + +`api_endpoints` +: The URI of the API, of the form `{api-id}.execute-api.{region}.amazonaws.com`. The stage name is typically appended to this URI to form a complete path to a deployed API stage. + +: **Field**: `api_endpoint` + +`api_gateway_managed` +: Specifies whether an API is managed by API Gateway. You cannot update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it. + +: **Field**: `api_gateway_managed` + +`api_ids` +: The API ID. + +: **Field**: `api_id` + +`api_key_selection_expressions` +: An API key selection expression. Supported only for WebSocket APIs. + +: **Field**: `api_key_selection_expression` + +`cors_configurations` +: A CORS configuration. Supported only for HTTP APIs. + +: **Field**: `cors_configuration` + +`created_dates` +: The timestamp when the API is created. + +: **Field**: `created_date` + +`descriptions` +: The description of the API. + +: **Field**: `description` + +`disable_schema_validations` +: Avoid validating models when creating a deployment. Supported only for WebSocket APIs. + +: **Field**: `disable_schema_validation` + +`disable_execute_api_endpoints` +: Specifies whether clients can invoke your API using the default execute-api endpoint. By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint. + +: **Field**: `disable_execute_api_endpoint` + +`import_infos` +: The validation information during API import. Supported only for HTTP APIs. + +: **Field**: `import_info` + +`names` +: The name of the API. + +: **Field**: `name` + +`protocol_types` +: The API protocol. Valid values are WEBSOCKET or HTTP. + +: **Field**: `protocol_type` + +`route_selection_expressions` +: The route selection expression for the API. For HTTP APIs, the `routeSelectionExpression` must be `${request.method} ${request.path}`. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs. + +: **Field**: `route_selection_expression` + +`tags` +: A collection of tags associated with the API. + +: **Field**: `tags` + +`versions` +: A version identifier for the API. + +: **Field**: `version` + +`warnings` +: The warning messages are reported when `failonwarnings` is turned on during API import. The `failonwarnings` specifies to roll back the API creation when a warning is encountered. By default, API creation continues if a warning is encountered. + +: **Field**: `warnings` + +## Examples + +### Test to ensure an API ID is available + +```ruby +describe aws_api_gateway_v2_apis do + its('api_ids') { should include 'REST_API_ID' } +end +``` + +### Test to ensure an API name is available + +```ruby +describe aws_api_gateway_v2_apis do + its('names') { should include 'REST_API_NAME' } +end +``` + +### Test to ensure a protocol type is `HTTP` + +```ruby +describe aws_api_gateway_v2_apis do + its('protocol_types') { should include 'HTTP' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_apis do + it { should exist } +end +``` + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_apis do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetApisResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_authorizer.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_authorizer.md new file mode 100644 index 0000000000..ca73c14cd2 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_authorizer.md @@ -0,0 +1,150 @@ ++++ +title = "aws_api_gateway_v2_authorizer resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_authorizer" +identifier = "inspec/resources/aws/aws_api_gateway_v2_authorizer resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_authorizer` InSpec audit resource to test the properties of a single specific AWS API Gateway V2 authorizer. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 Authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the authorizer exists. + +```ruby +describe aws_api_gateway_v2_authorizer(api_id: 'API_ID', authorizer_id: 'AUTHORIZER_ID') do + it { should exist } +end +``` + +## Parameters + +`api_id` _(required)_ +: The API identifier. + +`authorizer_id` _(required)_ +: The authorizer identifier. + +## Properties + +`authorizer_credentials_arn` +: Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. + +`authorizer_id` +: The authorizer identifier. + +`authorizer_result_ttl_in_seconds` +: The time to live (TTL) for cached authorizer results in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is **3600**, or **1 hour**. Supported only for HTTP API Lambda authorizers. + +`authorizer_type` +: The authorizer type. Specify `REQUEST` for a Lambda function using incoming request parameters. Specify `JWT` to use JSON Web Tokens (supported only for HTTP APIs). + +`authorizer_uri` +: The authorizer's Uniform Resource Identifier (URI). + +`identity_source` +: The identity source for which authorization is requested. + +`identity_validation_expression` +: The validation expression does not apply to the `REQUEST` authorizer. + +`jwt_configuration` +: Represents the configuration of a JWT authorizer. Required for the `JWT` authorizer type. Supported only for HTTP APIs. + +`jwt_configuration.audience` +: A list of the intended recipients of the `JWT`. A valid JWT must provide an `aud` that matches at least one entry in this list. Supported only for HTTP APIs. + +`jwt_configuration.issuer` +: The base domain of the identity provider that issues JSON Web Tokens. + +`name` +: The name of the authorizer. + +`authorizer_payload_format_version` +: Specifies the payload format sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are **1.0** and **2.0**. + +`enable_simple_responses` +: Specifies whether a Lambda authorizer returns a response in a simple format. + +## Examples + +### Test to ensure an authorizer ID is available + +```ruby +describe aws_api_gateway_v2_authorizer(api_id: 'API_ID', authorizer_id: 'AUTHORIZER_ID') do + its('authorizer_id') { should eq 'AUTHORIZER_ID' } +end +``` + +### Verify the authorizer result + +```ruby +describe aws_api_gateway_v2_authorizer(api_id: 'API_ID', authorizer_id: 'AUTHORIZER_ID') do + its('authorizer_result_ttl_in_seconds') { should eq 15 } +end +``` + +### Verify the authorizer type + +```ruby +describe aws_api_gateway_v2_authorizer(api_id: 'API_ID', authorizer_id: 'AUTHORIZER_ID') do + its('authorizer_type') { should eq 'JWT' } +end +``` + +### Verify the authorizer's name + +```ruby +describe aws_api_gateway_v2_authorizer(api_id: 'API_ID', authorizer_id: 'AUTHORIZER_ID') do + its('name') { should eq 'AUTHORIZER_NAME' } +end +``` + +### Verify the simple responses enabling status + +```ruby +describe aws_api_gateway_v2_authorizer(api_id: 'API_ID', authorizer_id: 'AUTHORIZER_ID') do + its('enable_simple_responses') { should eq true } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_authorizer(api_id: 'API_ID', authorizer_id: 'AUTHORIZER_ID') do + it { should exist } +end +``` + +### not exist + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_authorizer(api_id: 'API_ID', authorizer_id: 'AUTHORIZER_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetAuthorizerResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_authorizers.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_authorizers.md new file mode 100644 index 0000000000..0aa6378a8e --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_authorizers.md @@ -0,0 +1,171 @@ ++++ +title = "aws_api_gateway_v2_authorizers Resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_authorizers" +identifier = "inspec/resources/aws/aws_api_gateway_v2_authorizers Resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_authorizers` InSpec audit resource to test the properties of multiple AWS API Gateway V2 authorizers. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 Authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure the authorizers exist. + +```ruby +describe aws_api_gateway_v2_authorizers(api_id: 'API_ID') do + it { should exist } +end +``` + +## Parameters + +`api_id` _(required)_ +: The API identifier. + +## Properties + +`authorizer_credentials_arns` +: Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. + +: **Field**: `authorizer_credentials_arn` + +`authorizer_ids` +: The authorizer identifier. + +: **Field**: `authorizer_id` + +`authorizer_result_ttl_in_seconds` +: The time to live (TTL) for cached authorizer results in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is **3600**, or **1 hour**. Supported only for HTTP API Lambda authorizers. + +: **Field**: `authorizer_result_ttl_in_seconds` + +`authorizer_types` +: The authorizer type. Specify `REQUEST` for a Lambda function using incoming request parameters. Specify `JWT` to use JSON Web Tokens (supported only for HTTP APIs). + +: **Field**: `authorizer_type` + +`authorizer_uris` +: The authorizer's Uniform Resource Identifier (URI). + +: **Field**: `authorizer_uri` + +`identity_sources` +: The identity source for which authorization is requested. + +: **Field**: `identity_source` + +`identity_validation_expressions` +: The validation expression does not apply to the REQUEST authorizer. + +: **Field**: `identity_validation_expression` + +`jwt_configurations` +: Represents the configuration of a JWT authorizer. Required for the `JWT` authorizer type. Supported only for HTTP APIs. + +: **Field**: `jwt_configuration` + +`names` +: The name of the authorizer. + +: **Field**: `name` + +`authorizer_payload_format_versions` +: Specifies the payload format sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are **1.0** and **2.0**. + +: **Field**: `authorizer_payload_format_version` + +`enable_simple_responses` +: Specifies whether a Lambda authorizer returns a response in a simple format. + +: **Field**: `enable_simple_responses` + +## Examples + +### Check the number of authorizers in an API + +```ruby +describe aws_api_gateway_v2_authorizers(api_id: 'API_ID') do + its('count') { should eq 4 } +end +``` + +### Test to ensure an authorizer ID is available + +```ruby +describe aws_api_gateway_v2_authorizers(api_id: 'API_ID') do + its('authorizer_ids') { should include 'AUTHORIZER_ID' } +end +``` + +### Verify the authorizer result + +```ruby +describe aws_api_gateway_v2_authorizers(api_id: 'API_ID') do + its('authorizer_result_ttl_in_seconds') { should include 15 } +end +``` + +### Verify the authorizer type + +```ruby +describe aws_api_gateway_v2_authorizers(api_id: 'API_ID') do + its('authorizer_types') { should include 'JWT' } +end +``` + +### Verify the authorizer's name + +```ruby +describe aws_api_gateway_v2_authorizers(api_id: 'API_ID') do + its('names') { should include 'AUTHORIZER_NAME' } +end +``` + +### Verify the simple responses enabling status + +```ruby +describe aws_api_gateway_v2_authorizers(api_id: 'API_ID') do + its('enable_simple_responses') { should include true } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_authorizers(api_id: 'API_ID') do + it { should exist } +end +``` + +### not exist + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_authorizers(api_id: 'API_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetAuthorizersResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_deployment.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_deployment.md new file mode 100644 index 0000000000..4dfda81b64 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_deployment.md @@ -0,0 +1,129 @@ ++++ +title = "aws_api_gateway_v2_deployment resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_deployment" +identifier = "inspec/resources/aws/aws_api_gateway_v2_deployment resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_deployment` InSpec audit resource to test the properties of a specific AWS API Gateway V2 deployment. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the deployment exists. + +```ruby +describe aws_api_gateway_v2_deployment(api_id: 'APP_ID', deployment_id: 'DEPLOYMENT_ID') do + it { should exist } +end +``` + +## Parameters + +`api_id` _(required)_ +: The API identifier. + +`deployment_id` _(required)_ +: The identifier for the deployment. + +## Properties + +`auto_deployed` +: Specifies whether the deployment was automatically released. + +`created_date` +: The date and time when the deployment resource was created. + +`deployment_id` +: The identifier for the deployment. + +`deployment_status` +: The status of the deployment. The valid values are `PENDING`, `FAILED`, or `SUCCEEDED`. + +`deployment_status_message` +: May contain additional feedback on the status of an API deployment. + +`description` +: The description for the deployment. + +## Examples + +### Test to ensure a deployment ID is available + +```ruby +describe aws_api_gateway_v2_deployment(api_id: 'APP_ID', deployment_id: 'DEPLOYMENT_ID') do + its('deployment_id') { should eq 'DEPLOYMENT_ID' } +end +``` + +### Test to verify the deployment status + +```ruby +describe aws_api_gateway_v2_deployment(api_id: 'APP_ID', deployment_id: 'DEPLOYMENT_ID') do + its('deployment_status') { should eq 'DEPLOYED' } +end +``` + +### Test to ensure an authorizer type is `JWT` for a deployment + +```ruby +describe aws_api_gateway_v2_deployment(api_id: 'APP_ID', deployment_id: 'DEPLOYMENT_ID') do + its('authorizer_type') { should eq 'JWT' } +end +``` + +### Test to ensure a description is available + +```ruby +describe aws_api_gateway_v2_deployment(api_id: 'APP_ID', deployment_id: 'DEPLOYMENT_ID') do + its('description') { should eq 'DEPLOYMENT_DESCRIPTION' } +end +``` + +### Test to ensure an auto-deployment is enabled for a deployment + +```ruby +describe aws_api_gateway_v2_deployment(api_id: 'APP_ID', deployment_id: 'DEPLOYMENT_ID') do + its('auto_deployed') { should eq true } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_deployment(api_id: 'APP_ID', deployment_id: 'DEPLOYMENT_ID') do + it { should exist } +end +``` + +### not exists + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_deployment(api_id: 'APP_ID', deployment_id: 'DEPLOYMENT_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetDeploymentResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_deployments.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_deployments.md new file mode 100644 index 0000000000..baff07ee90 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_deployments.md @@ -0,0 +1,139 @@ ++++ +title = "aws_api_gateway_v2_deployments Resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_deployments" +identifier = "inspec/resources/aws/aws_api_gateway_v2_deployments Resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_deployments` InSpec audit resource to test properties of multiple AWS API Gateway V2 deployments. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the deployment exists. + +```ruby +describe aws_api_gateway_v2_deployments(api_id: 'APP_ID') do + it { should exist } +end +``` + +## Parameters + +`api_id` _(required)_ + +: The API identifier. + +## Properties + +`auto_deployeds` +: Specifies whether the deployment was automatically released. + +: **Field**: `auto_deployed` + +`created_dates` +: The date and time when the Deployment resource was created. + +: **Field**: `created_date` + +`deployment_ids` +: The identifier for the deployment. + +: **Field**: `deployment_id` + +`deployment_statuses` +: The status of the deployment: PENDING, FAILED, or SUCCEEDED. + +: **Field**: `deployment_status` + +`deployment_status_messages` +: May contain additional feedback on the status of an API deployment. + +: **Field**: `deployment_status_message` + +`descriptions` +: The description for the deployment. + +: **Field**: `description` + +## Examples + +### Test to ensure a deployment ID is available + +```ruby +describe aws_api_gateway_v2_deployments(api_id: 'APP_ID') do + its('deployment_ids') { should include 'DEPLOYMENT_ID' } +end +``` + +### Test to verify the deployment status + +```ruby +describe aws_api_gateway_v2_deployments(api_id: 'APP_ID') do + its('deployment_statuses') { should include 'DEPLOYED' } +end +``` + +### Test to ensure an authorizer type has `JWT` + +```ruby +describe aws_api_gateway_v2_deployments(api_id: 'APP_ID') do + its('authorizer_types') { should include 'JWT' } +end +``` + +### Test to ensure a description is available + +```ruby +describe aws_api_gateway_v2_deployments(api_id: 'APP_ID') do + its('descriptions') { should include 'DEPLOYMENT_DESCRIPTION' } +end +``` + +### Test to ensure an auto-deployment is enabled for a deployment + +```ruby +describe aws_api_gateway_v2_deployments(api_id: 'APP_ID') do + its('auto_deployeds') { should include true } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_deployments(api_id: 'APP_ID') do + it { should exist } +end +``` + +### not exists + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_deployments(api_id: 'APP_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetDeploymentsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_domain_name.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_domain_name.md new file mode 100644 index 0000000000..8995062576 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_domain_name.md @@ -0,0 +1,164 @@ ++++ +title = "aws_api_gateway_v2_domain_name resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_domain_name" +identifier = "inspec/resources/aws/aws_api_gateway_v2_domain_name resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_domain_name` InSpec audit resource to test the properties of a specific AWS API Gateway V2 domain name. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the domain name exists. + +```ruby +describe aws_api_gateway_v2_domain_name(domain_name: 'DOMAIN_NAME') do + it { should exist } +end +``` + +## Parameters + +`domain_name` _(required)_ +: The domain name. + +## Properties + +`api_mapping_selection_expression` +: The API mapping selection expression. + +: **Field**: `api_mapping_selection_expression` + +`domain_name` +: A domain name for the API. + +: **Field**: `domain_name` + +`api_gateway_domain_names` +: A domain name for the API. + +: **Field**: `domain_name_status_messages[0].api_gateway_domain_name` + +`certificate_arns` +: An AWS-managed certificate is used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source. + +: **Field**: `domain_name_status_messages[0].certificate_arn` + +`certificate_names` +: The user-friendly name of the certificate used by the edge-optimized endpoint for this domain name. + +: **Field**: `domain_name_status_messages[0].certificate_name` + +`certificate_upload_dates` +: The timestamp when the certificate has been used by the edge-optimized endpoint for this domain name when uploaded. + +: **Field**: `domain_name_status_messages[0].certificate_upload_date` + +`domain_name_statuses` +: The status of the domain name migration. The valid values are `AVAILABLE`, `UPDATING`, `PENDING_CERTIFICATE_REIMPORT`, and `PENDING_OWNERSHIP_VERIFICATION`. + +: **Field**: `domain_name_status_messages[0].domain_name_status` + +`domain_name_status_messages` +: An optional text message containing detailed information about the domain name migration status. + +: **Field**: `domain_name_status_messages[0].domain_name_status_message` + +`endpoint_types` +: The endpoint type. + +: **Field**: `domain_name_status_messages[0].endpoint_type` + +`hosted_zone_ids` +: The Amazon Route 53 Hosted Zone ID of the endpoint. + +: **Field**: `domain_name_status_messages[0].hosted_zone_id` + +`security_policies` +: The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are `TLS_1_0` and `TLS_1_2`. + +: **Field**: `domain_name_status_messages[0].security_policy` + +`ownership_verification_certificate_arns` +: The ARN of the public certificate issued by ACM to validate ownership of the custom domain. + +: **Field**: `domain_name_status_messages[0].ownership_verification_certificate_arn` + +`truststore_uri` +: An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. + +: **Field**: `mutual_tls_authentication.truststore_uri` + +`truststore_version` +: The version of the S3 object that contains the truststore. + +: **Field**: `mutual_tls_authentication.truststore_version` + +`truststore_warnings` +: A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. + +: **Field**: `mutual_tls_authentication.truststore_warnings` + +`tags` +: The collection of tags associated with a domain name. + +: **Field**: `tags` + +## Examples + +### Test to ensure the domain name is available + +```ruby +describe aws_api_gateway_v2_domain_name(domain_name: 'DOMAIN_NAME') do + its('domain_name') { should eq 'DOMAIN_NAME' } +end +``` + +### Test to verify the domain status + +```ruby +describe aws_api_gateway_v2_domain_name(domain_name: 'DOMAIN_NAME') do + its('domain_name_configurations[0].domain_name_status') { should eq 'AVAILABLE' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_domain_name(domain_name: 'DOMAIN_NAME') do + it { should exist } +end +``` + +### not exist + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_domain_name(domain_name: 'DOMAIN_NAME') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetDomainNameResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_domain_names.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_domain_names.md new file mode 100644 index 0000000000..d3a262a794 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_domain_names.md @@ -0,0 +1,113 @@ ++++ +title = "aws_api_gateway_v2_domain_names Resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_domain_names" +identifier = "inspec/resources/aws/aws_api_gateway_v2_domain_names Resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_domain_names` InSpec audit resource to test properties of multiple AWS API Gateway V2 domain names. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the domain name exists. + +```ruby +describe aws_api_gateway_v2_domain_names do + it { should exist } +end +``` + +## Parameters + +This resource does not require any parameters. + +## Properties + +`authorizer_credentials_arns` +: Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. + +: **Field**: `authorizer_credentials_arn` + +`api_mapping_selection_expressions` +: The API mapping selection expression. + +: **Field**: `api_mapping_selection_expression` + +`domain_names` +: A domain name for the API. + +: **Field**: `domain_name` + +`domain_name_configurations` +: The configuration of the domain name. + +: **Field**: `domain_name_configurations` + +`mutual_tls_authentications` +: This is TLS authentication. + +: **Field**: `mutual_tls_authentication` + +`tags` +: The collection of tags associated with a domain name. + +: **Field**: `tags` + +## Examples + +### Test to ensure a domain name is available + +```ruby +describe aws_api_gateway_v2_domain_names do + its('domain_names') { should eq 'DOMAIN_NAME' } +end +``` + +### Test to verify if domain configurations are set + +```ruby +describe aws_api_gateway_v2_domain_names do + its('domain_name_configurations') { should eq 'AVAILABLE' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_domain_names do + it { should exist } +end +``` + +### not exist + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_domain_names do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetDomainNamesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integration.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integration.md new file mode 100644 index 0000000000..0b312fd31b --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integration.md @@ -0,0 +1,182 @@ ++++ +title = "aws_api_gateway_v2_integration resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_integration" +identifier = "inspec/resources/aws/aws_api_gateway_v2_integration resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_integration` InSpec audit resource to test the properties of a specific AWS API Gateway V2 integration. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the integration exists. + +```ruby +describe aws_api_gateway_v2_integration(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID') do + it { should exist } +end +``` + +## Parameters + +`api_id` _(required)_ +: The API identifier. + +`integration_id` _(required)_ +: The integration ID. + +## Properties + +`api_gateway_managed` +: Specifies whether API Gateway manages integration. + +`connection_id` +: The VPC link ID for a private integration. Supported only for HTTP APIs. + +`connection_type` +: The network connection type to the integration endpoint. Specify `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and resources in a VPC. The default value is `INTERNET`. + +`content_handling_strategy` +: Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors: + +- `CONVERT_TO_BINARY`: Converts a response payload from a Base64-encoded string to the corresponding binary blob. +- `CONVERT_TO_TEXT`: Converts a response payload from a binary blob to a Base64-encoded string. + +If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification. + +`credentials_arn` +: Specifies the credentials required for the integration, if any. + +`description` +: The description of an integration. + +`integration_id` +: The identifier of an integration. + +`integration_method` +: Specifies the integration's HTTP method type. + +`integration_response_selection_expression` +: The integration response selection expression for the integration. Supported only for WebSocket APIs. + +`integration_subtype` +: Supported only for HTTP API `AWS_PROXY` integrations. Specifies the AWS service action to invoke. + +`integration_type` +: The integration type. One of the following: + +- `AWS`: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs. +- `AWS_PROXY`: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration. +- `HTTP`: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs. +- `HTTP_PROXY`: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as `HTTP proxy` integration. +- `MOCK`: for integrating the route or method request with API Gateway as a **loopback** endpoint without invoking any backend. Supported only for WebSocket APIs. + +`integration_uri` +: For a Lambda integration, specify the URI of a Lambda function. + +For an HTTP integration, specify a fully-qualified URL. + +For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses `DiscoverInstances` to identify resources. You can use query parameters to target specific resources. + +`passthrough_behavior` +: Specifies the pass-through behavior for incoming requests based on the `Content-Type` header in the request, and the available mapping templates specified as the `requestTemplates` property on the `Integration` resource. There are three valid values: `WHEN_NO_MATCH`, `WHEN_NO_TEMPLATES`, and `NEVER`. Supported only for WebSocket APIs. + +- `WHEN_NO_MATCH` passes the request body for unmapped content types to the integration backend without transformation. +- `NEVER` rejects unmapped content types with an `HTTP 415 Unsupported Media Type` response. +- `WHEN_NO_TEMPLATES` allows pass-through when the integration has no content types mapped to templates. However, if at least one content type defined, unmapped content types will be rejected with the same `HTTP 415 Unsupported Media Type` response. + +`payload_format_version` +: Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are `1.0` and `2.0`. For all other integrations, `1.0` is the only supported value. + +`request_parameters` +: For WebSocket APIs, a key-value map specifies request parameters passed from the method request to the backend. The key is an integration request parameter name. The associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of `method.request.{location}.{name}`, where `{location}` is **query string, path, or header**; and `{name}` must be a valid and unique method request parameter name. + +`response_parameters` +: Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern `:
.` or `overwrite.statuscode`. The action can be `append`, `overwrite` or `remove`. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. + +`request_templates` +: Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs. + +`template_selection_expression` +: The template selection expression for the integration. Supported only for WebSocket APIs. + +`timeout_in_millis` +: Custom timeout between **50** and **29,000 milliseconds** for WebSocket APIs and between **50** and **30,000 milliseconds** for HTTP APIs. The default timeout is **29 seconds** for WebSocket APIs and **30 seconds** for HTTP APIs. + +`tls_config.server_name_to_verify` +: The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs. If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting. + +## Examples + +### Test to ensure an integration ID is available + +```ruby +describe aws_api_gateway_v2_integration(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID') do + its('integration_id') { should eq 'INTEGRATION_ID' } +end +``` + +### Verify the connection type + +```ruby +describe aws_api_gateway_v2_integration(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID') do + its('connection_type') { should eq 'INTERNET' } +end +``` + +### Verify the integration type + +```ruby +describe aws_api_gateway_v2_integration(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID') do + its('integration_type') { should eq 'AWS' } +end +``` + +### Verify the pass-through behavior + +```ruby +describe aws_api_gateway_v2_integration(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID') do + its('passthrough_behavior') { should eq 'NEVER' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_integration(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID') do + it { should exist } +end +``` + +### not exist + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_integration(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetIntegrationResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integration_response.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integration_response.md new file mode 100644 index 0000000000..ca0ce58a7a --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integration_response.md @@ -0,0 +1,121 @@ ++++ +title = "aws_api_gateway_v2_integration_response resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_integration_response" +identifier = "inspec/resources/aws/aws_api_gateway_v2_integration_response resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_integration_response` InSpec audit resource to test the properties of a specific AWS API Gateway V2 integration response. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 IntegrationResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the integration response exists. + +```ruby +describe aws_api_gateway_v2_integration_response(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID', integration_response_id: 'INTEGRATION_RESPONSE_ID') do + it { should exist } +end +``` + +## Parameters + +`api_id` _(required)_ +: The API identifier. + +`integration_id` _(required)_ +: The integration ID. + +`integration_response_id` _(required)_ +: The integration response ID. + +## Properties + +`content_handling_strategy` +: Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors: + +- **CONVERT_TO_BINARY**: Converts a response payload from a Base64-encoded string to the corresponding binary blob. +- **CONVERT_TO_TEXT**: Converts a response payload from a binary blob to a Base64-encoded string. + +If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification. + +`integration_response_id` +: The integration response ID. + +`integration_response_key` +: The integration response key. + +`response_parameters` +: A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name. The mapped value is an integration response header value, a static value enclosed within a pair of single quotes or a JSON expression from the integration response body. The mapping key must match the pattern of `method.response.header.{name}`, where **name** is a valid and unique header name. The mapped non-static value must match the pattern of `integration.response.header.{name}` or `integration.response.body.{JSON-expression}`, where the name is a valid and unique response header name and JSON-expression is a valid JSON expression without the `$` prefix. + +`response_templates` +: The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key or value map, with a content type as the key and a template as the value. + +`template_selection_expression` +: The template selection expressions for the integration response. Supported only for WebSocket APIs. + +## Examples + +### Test to ensure that an integration response ID is available + +```ruby +describe aws_api_gateway_v2_integration_response(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID', integration_response_id: 'INTEGRATION_RESPONSE_ID') do + its('integration_response_id') { should eq 'INTEGRATION_RESPONSE_ID' } +end +``` + +### Test to verify the integration response key + +```ruby +describe aws_api_gateway_v2_integration_response(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID', integration_response_id: 'INTEGRATION_RESPONSE_ID') do + its('integration_response_key') { should eq 'INTEGRATION_RESPONSE_KEY' } +end +``` + +### Test to verify the content handling strategy + +```ruby +describe aws_api_gateway_v2_integration_response(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID', integration_response_id: 'INTEGRATION_RESPONSE_ID') do + its('content_handling_strategy') { should eq 'CONVERT_TO_BINARY' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least a result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_integration_response(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID', integration_response_id: 'INTEGRATION_RESPONSE_ID') do + it { should exist } +end +``` + +### not exist + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_integration_response(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID', integration_response_id: 'INTEGRATION_RESPONSE_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetIntegrationResponseResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integration_responses.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integration_responses.md new file mode 100644 index 0000000000..9721b841e1 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integration_responses.md @@ -0,0 +1,130 @@ ++++ +title = "aws_api_gateway_v2_integration_responses Resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_integration_responses" +identifier = "inspec/resources/aws/aws_api_gateway_v2_integration_responses Resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_integration_responses` InSpec audit resource to test properties of multiple AWS API Gateway V2 integration responses. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 IntegrationResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the integration response exists. + +```ruby +describe aws_api_gateway_v2_integration_responses(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID') do + it { should exist } +end +``` + +## Parameters + +`api_id` _(required)_ +: The API identifier. + +`route_id` _(required)_ +: The route identifier. + +## Properties + +`content_handling_strategies` +: Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors: + +- **CONVERT_TO_BINARY**: Converts a response payload from a Base64-encoded string to the corresponding binary blob. +- **CONVERT_TO_TEXT**: Converts a response payload from a binary blob to a Base64-encoded string. + +If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification. + +: **Field**: `content_handling_strategy` + +`integration_response_ids` +: The integration response ID. + +: **Field**: `integration_response_id` + +`integration_response_keys` +: The integration response key. + +: **Field**: `integration_response_key` + +`response_parameters` +: A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name. The mapped value is an integration response header value, a static value enclosed within a pair of single quotes or a JSON expression from the integration response body. The mapping key must match the pattern of `method.response.header.{name}`, where **name** is a valid and unique header name. The mapped non-static value must match the pattern of `integration.response.header.{name}` or `integration.response.body.{JSON-expression}`, where the name is a valid and unique response header name and JSON-expression is a valid JSON expression without the `$` prefix. + +: **Field**: `response_parameters` + +`response_templates` +: The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key or value map, with a content type as the key and a template as the value. + +: **Field**: `response_templates` + +`template_selection_expressions` +: The template selection expressions for the integration response. Supported only for WebSocket APIs. + +: **Field**: `template_selection_expression` + +## Examples + +### Test to ensure an integration response ID is available + +```ruby +describe aws_api_gateway_v2_integration_responses(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID') do + its('integration_response_ids') { should include 'INTEGRATION_RESPONSE_ID' } +end +``` + +### Test to verify the integration response key + +```ruby +describe aws_api_gateway_v2_integration_responses(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID') do + its('integration_response_keys') { should include 'INTEGRATION_RESPONSE_KEY' } +end +``` + +### Test to verify the content handling strategy + +```ruby +describe aws_api_gateway_v2_integration_responses(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID') do + its('content_handling_strategy') { should include 'CONVERT_TO_BINARY' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least a result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_integration_responses(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID') do + it { should exist } +end +``` + +### not exist + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_integration_responses(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetIntegrationResponsesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integrations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integrations.md new file mode 100644 index 0000000000..a726178f2e --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_integrations.md @@ -0,0 +1,219 @@ ++++ +title = "aws_api_gateway_v2_integrations Resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_integrations" +identifier = "inspec/resources/aws/aws_api_gateway_v2_integrations Resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_integrations` InSpec audit resource to test properties of multiple AWS API Gateway V2 integrations. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the integration exists. + +```ruby +describe aws_api_gateway_v2_integrations(api_id: 'APP_ID') do + it { should exist } +end +``` + +## Parameters + +`api_id` _(required)_ +: The API identifier. + +## Properties + +`api_gateway_manageds` +: Specifies whether API Gateway manages integration. + +: **Field**: `api_gateway_managed` + +`connection_ids` +: The VPC link ID for a private integration. Supported only for HTTP APIs. + +: **Field**: `connection_id` + +`connection_types` +: The network connection type to the integration endpoint. Specify `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and resources in a VPC. The default value is `INTERNET`. + +: **Field**: `connection_type` + +`content_handling_strategies` +: Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors: + +- `CONVERT_TO_BINARY`: Converts a response payload from a Base64-encoded string to the corresponding binary blob. +- `CONVERT_TO_TEXT`: Converts a response payload from a binary blob to a Base64-encoded string. + +If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification. + +: **Field**: `content_handling_strategy` + +`credentials_arns` +: Specifies the credentials required for the integration, if any. + +: **Field**: `credentials_arn` + +`descriptions` +: Represents the description of an integration. + +: **Field**: `description` + +`integration_ids` +: Represents the identifier of an integration. + +: **Field**: `integration_id` + +`integration_methods` +: Specifies the integration's HTTP method type. + +: **Field**: `integration_method` + +`integration_response_selection_expressions` +: The integration response selection expression for the integration. Supported only for WebSocket APIs. + +: **Field**: `integration_response_selection_expression` + +`integration_subtypes` +: Supported only for `HTTP API AWS_PROXY integrations`. Specifies the AWS service action to invoke. + +: **Field**: `integration_subtype` + +`integration_types` +: The integration type. One of the following: + +- `AWS`: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs. +- `AWS_PROXY`: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration. +`HTTP`: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs. +`HTTP_PROXY`: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. +`MOCK`: for integrating the route or method request with API Gateway as a **loopback** endpoint without invoking any backend. Supported only for WebSocket APIs. + +: **Field**: `integration_type` + +`integration_uris` +: For a Lambda integration, specify the URI of a Lambda function. + +For an HTTP integration, specify a fully-qualified URL. + +For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses `DiscoverInstances` to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account. + +: **Field**: `integration_uri` + +`passthrough_behaviors` +: Specifies the pass-through behavior for incoming requests based on the `Content-Type` header in the request and the available mapping templates specified as the `requestTemplates` property on the `Integration` resource. There are three valid values: `WHEN_NO_MATCH`, `WHEN_NO_TEMPLATES`, and `NEVER`. Supported only for WebSocket APIs. + +- `WHEN_NO_MATCH` passes the request body for unmapped content types to the integration backend without transformation. +- `NEVER` rejects unmapped content types with an `HTTP 415 Unsupported Media Type` response. +- `WHEN_NO_TEMPLATES` allows pass-through when the integration has no content types mapped to templates. However, if at least one content type defined, unmapped content types will be rejected with the same `HTTP 415 Unsupported Media Type` response. + +: **Field**: `passthrough_behavior` + +`payload_format_versions` +: Specifies the format of the payload sent to an integration. Required for HTTP APIs. + +: **Field**: `payload_format_version` + +`request_parameters` +: For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name. The associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of `method.request.{location}.{name}`, where `{location}` is **query string, path, or header**; and `{name}` must be a valid and unique method request parameter name. + +: **Field**: `request_parameters` + +`response_parameters` +: Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern `:
.` or `overwrite.statuscode`. The action can be `append`, `overwrite` or `remove`. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. + +: **Field**: `response_parameters` + +`request_templates` +: Represents a map of Velocity templates applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs. + +: **Field**: `request_templates` + +`template_selection_expressions` +: The template selection expression for the integration. Supported only for WebSocket APIs. + +: **Field**: `template_selection_expression` + +`timeout_in_millis` +: Custom timeout between **50** and **29,000** milliseconds for WebSocket APIs and between **50** and **30,000** milliseconds for HTTP APIs. The default timeout is **29 seconds** for WebSocket APIs and **30 seconds** for HTTP APIs. + +: **Field**: `timeout_in_millis` + +`tls_configs` +: The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs. + +: **Field**: `tls_config` + +## Examples + +### Test to ensure an integration ID is available + +```ruby +describe aws_api_gateway_v2_integrations(api_id: 'APP_ID') do + its('integration_ids') { should include 'INTEGRATION_ID' } +end +``` + +### Test to verify the connection type + +```ruby +describe aws_api_gateway_v2_integrations(api_id: 'APP_ID') do + its('connection_types') { should include 'INTERNET' } +end +``` + +### Test to verify the integration type + +```ruby +describe aws_api_gateway_v2_integrations(api_id: 'APP_ID') do + its('integration_types') { should include 'AWS' } +end +``` + +### Test to Verify the pass-through behavior + +```ruby +describe aws_api_gateway_v2_integrations(api_id: 'APP_ID') do + its('passthrough_behaviors') { should include 'NEVER' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_integrations(api_id: 'APP_ID') do + it { should exist } +end +``` + +### not exists + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_integrations(api_id: 'APP_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetIntegrationsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_model.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_model.md new file mode 100644 index 0000000000..0015502e8d --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_model.md @@ -0,0 +1,118 @@ ++++ +title = "aws_api_gateway_v2_model resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_model" +identifier = "inspec/resources/aws/aws_api_gateway_v2_model resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_model` InSpec audit resource to test the properties of a specific AWS API Gateway V2 model. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 Model](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the model exists. + +```ruby +describe aws_api_gateway_v2_model(api_id: 'APP_ID', model_id: 'MODEL_ID') do + it { should exist } +end +``` + +## Parameters + +`api_id` _(required)_ +: The API identifier. + +`model_id` _(required)_ +: The model identifier. + +## Properties + +`content_type` +: The content-type for the model, for example, **application/json**. + +`description` +: The description of the model. + +`model_id` +: The model identifier. + +`name` +: The name of the model. Must be alphanumeric. + +`schema` +: The schema for the model. For application/json models, this should be JSON schema draft 4 model. + +## Examples + +### Test to ensure a model ID is available + +```ruby +describe aws_api_gateway_v2_model(api_id: 'APP_ID', model_id: 'MODEL_ID') do + its('model_id') { should eq 'MODEL_ID' } +end +``` + +### Test to verify the model name + +```ruby +describe aws_api_gateway_v2_model(api_id: 'APP_ID', model_id: 'MODEL_ID') do + its('name') { should eq 'MODEL_NAME' } +end +``` + +### Test to verify the model description + +```ruby +describe aws_api_gateway_v2_model(api_id: 'APP_ID', model_id: 'MODEL_ID') do + its('description') { should eq 'MODEL_DESCRIPTION' } +end +``` + +### Test to verify the model content type + +```ruby +describe aws_api_gateway_v2_model(api_id: 'APP_ID', model_id: 'MODEL_ID') do + its('content_type') { should eq 'application/json' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_model(api_id: 'APP_ID', model_id: 'MODEL_ID') do + it { should exist } +end +``` + +### not exist + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_model(api_id: 'APP_ID', model_id: 'MODEL_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetModelResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_models.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_models.md new file mode 100644 index 0000000000..b84b760303 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_models.md @@ -0,0 +1,125 @@ ++++ +title = "aws_api_gateway_v2_models Resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_models" +identifier = "inspec/resources/aws/aws_api_gateway_v2_models Resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_models` InSpec audit resource to test the properties of multiple AWS API Gateway V2 models. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 Model](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the model exists. + +```ruby +describe aws_api_gateway_v2_models(api_id: 'APP_ID') do + it { should exist } +end +``` + +## Parameters + +`api_id` _(required)_ +: The API identifier. + +## Properties + +`content_types` +: The content-type for the model, for example, **application/json**. + +: **Field**: `content_type` + +`descriptions` +: The description of the model. + +: **Field**: `description` + +`model_ids` +: The model identifier. + +: **Field**: `model_id` + +`names` +: The name of the model. Must be alphanumeric. + +: **Field**: `name` + +`schemas` +: The schema for the model. For application/json models, this should be JSON schema draft 4 model. + +: **Field**: `schema` + +## Examples + +### Test to ensure a model ID is available + +```ruby +describe aws_api_gateway_v2_models(api_id: 'APP_ID') do + its('model_ids') { should include 'MODEL_ID' } +end +``` + +### Test to verify the model name + +```ruby +describe aws_api_gateway_v2_models(api_id: 'APP_ID') do + its('names') { should include 'MODEL_NAME' } +end +``` + +### Test to verify the model description + +```ruby +describe aws_api_gateway_v2_models(api_id: 'APP_ID') do + its('descriptions') { should include 'MODEL_DESCRIPTION' } +end +``` + +### Test to verify the model content type is 'application/json' + +```ruby +describe aws_api_gateway_v2_models(api_id: 'APP_ID') do + its('content_types') { should include 'application/json' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_models(api_id: 'APP_ID') do + it { should exist } +end +``` + +### not exist + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_models(api_id: 'APP_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetModelsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_route.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_route.md new file mode 100644 index 0000000000..d4bbd9aa4f --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_route.md @@ -0,0 +1,158 @@ ++++ +title = "aws_api_gateway_v2_route resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_route" +identifier = "inspec/resources/aws/aws_api_gateway_v2_route resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_route` InSpec audit resource to test the properties of a specific AWS API Gateway V2 Route. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 Route](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the route exists. + +```ruby +describe aws_api_gateway_v2_route(api_id: 'APP_ID', route_id: 'ROUTE_ID') do + it { should exist } +end +``` + +## Parameters + +`api_id` _(required)_ +: The API identifier. + +`route_id` _(required)_ +: The route identifier. + +## Properties + +`api_gateway_managed` +: Specifies whether a route is managed by API Gateway. If you created an API using quick create, the `$default` route is managed by API Gateway. You cannot modify the `$default` route key. + +`api_key_required` +: Specifies whether an API key is required for this route. Supported only for WebSocket APIs. + +`authorization_scopes` +: A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes. + +`authorization_type` +: The authorization type for the route. For WebSocket APIs, valid values are `NONE` for open access, `AWS_IAM` for using AWS IAM permissions, and `CUSTOM` for using a Lambda authorizer. For HTTP APIs, valid values are `NONE` for open access, `JWT` for using JSON Web Tokens, `AWS_IAM` for using AWS IAM permissions, and `CUSTOM` for using a Lambda authorizer. + +`authorizer_id` +: The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer. + +`model_selection_expression` +: The model selection expression for the route. Supported only for WebSocket APIs. + +`operation_name` +: The operation name for the route. + +`request_models` +: The request models for the route. Supported only for WebSocket APIs. + +`request_parameters` +: The request parameters for the route. Supported only for WebSocket APIs. + +`route_id` +: The route ID. + +`route_key` +: The route key for the route. + +`route_response_selection_expression` +: The route response selection expression for the route. Supported only for WebSocket APIs. + +`target` +: The target for the route. + +## Examples + +### Test to ensure an authorizer ID is available + +```ruby +describe aws_api_gateway_v2_route(api_id: 'APP_ID', route_id: 'ROUTE_ID') do + its('authorizer_id') { should eq 'AUTHORIZER_ID' } +end +``` + +### Test to verify the requirement of the API key + +```ruby +describe aws_api_gateway_v2_route(api_id: 'APP_ID', route_id: 'ROUTE_ID') do + its('api_key_required') { should eq true } +end +``` + +### Test to verify the authorization type + +```ruby +describe aws_api_gateway_v2_route(api_id: 'APP_ID', route_id: 'ROUTE_ID') do + its('authorization_type') { should eq 'JWT' } +end +``` + +### Test to verify the operation name + +```ruby +describe aws_api_gateway_v2_route(api_id: 'APP_ID', route_id: 'ROUTE_ID') do + its('operation_name') { should eq 'OPERATION_NAME' } +end +``` + +### Test to ensure a route key is available + +```ruby +describe aws_api_gateway_v2_route(api_id: 'APP_ID', route_id: 'ROUTE_ID') do + its('route_key') { should eq 'ROUTE_KEY' } +end +``` + +### Test to verify the target + +```ruby +describe aws_api_gateway_v2_route(api_id: 'APP_ID', route_id: 'ROUTE_ID') do + its('target') { should eq 'ROUTE_TARGET' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_route(api_id: 'APP_ID', route_id: 'ROUTE_ID') do + it { should exist } +end +``` + +### not exist + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_route(api_id: 'APP_ID', route_id: 'ROUTE_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetRouteResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_routes.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_routes.md new file mode 100644 index 0000000000..a7ad9b823e --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_v2_routes.md @@ -0,0 +1,165 @@ ++++ +title = "aws_api_gateway_v2_routes Resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_v2_routes" +identifier = "inspec/resources/aws/aws_api_gateway_v2_routes Resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_v2_routes` InSpec audit resource to test the properties of multiple AWS API Gateway V2 Routes. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGatewayV2 Route](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that the route exists. + +```ruby +describe aws_api_gateway_v2_routes(api_id: 'APP_ID') do + it { should exist } +end +``` + +## Parameters + +`api_id` _(required)_ +: The API identifier. + +## Properties + +`api_gateway_manageds` +: Specifies whether a route is managed by API Gateway. If you created an API using quick create, the `$default` route is managed by API Gateway. You cannot modify the `$default` route key. + +: **Field**: `api_gateway_managed` + +`api_key_requireds` +: Specifies whether an API key is required for this route. Supported only for WebSocket APIs. + +: **Field**: `api_key_required` + +`authorization_scopes` +: A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes. + +: **Field**: `authorization_scopes` + +`authorization_types` +: The authorization type for the route. For WebSocket APIs, valid values are `NONE` for open access, `AWS_IAM` for using AWS IAM permissions, and `CUSTOM` for using a Lambda authorizer. For HTTP APIs, valid values are `NONE` for open access, `JWT` for using JSON Web Tokens, `AWS_IAM` for using AWS IAM permissions, and `CUSTOM` for using a Lambda authorizer. + +: **Field**: `authorization_type` + +`authorizer_ids` +: The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer. + +: **Field**: `authorizer_id` + +`model_selection_expressions` +: The model selection expression for the route. Supported only for WebSocket APIs. + +: **Field**: `model_selection_expression` + +`operation_names` +: The operation name for the route. + +: **Field**: `operation_name` + +`request_models` +: The request models for the route. Supported only for WebSocket APIs. + +: **Field**: `request_models` + +`request_parameters` +: The request parameters for the route. Supported only for WebSocket APIs. + +: **Field**: `request_parameters` + +`route_ids` +: The route ID. + +: **Field**: `route_id` + +`route_keys` +: The route key for the route. + +: **Field**: `route_key` + +`route_response_selection_expressions` +: The route response selection expression for the route. Supported only for WebSocket APIs. + +: **Field**: `route_response_selection_expression` + +`targets` +: The target for the route. + +: **Field**: `target` + +## Examples + +### Test to ensure an authorizer ID is available + +```ruby +describe aws_api_gateway_v2_routes(api_id: 'APP_ID') do + its('authorizer_ids') { should include 'AUTHORIZER_ID' } +end +``` + +### Test to verify the requirement of the API key + +```ruby +describe aws_api_gateway_v2_routes(api_id: 'APP_ID') do + its('api_key_requireds') { should include true } +end +``` + +### Test to verify the authorization type + +```ruby +describe aws_api_gateway_v2_routes(api_id: 'APP_ID') do + its('authorization_types') { should include 'JWT' } +end +``` + +### Test to verify the operation name + +```ruby +describe aws_api_gateway_v2_routes(api_id: 'APP_ID') do + its('operation_names') { should include 'OPERATION_NAME' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_v2_routes(api_id: 'APP_ID') do + it { should exist } +end +``` + +### not exist + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_v2_routes(api_id: 'APP_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGatewayv2:Client:GetRoutesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_vpc_link.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_vpc_link.md new file mode 100644 index 0000000000..eb55fde4b0 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_vpc_link.md @@ -0,0 +1,112 @@ ++++ +title = "aws_api_gateway_vpc_link resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_vpc_link" +identifier = "inspec/resources/aws/aws_api_gateway_vpc_link resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_vpc_link` InSpec audit resource to test the properties of a single specific AWS API Gateway VPC link. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGateway VPCLink](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that a VPC link exists. + +```ruby +describe aws_api_gateway_vpc_link(vpc_link_id: 'VPC_LINK_ID') do + it { should exist } +end +``` + +## Parameters + +`vpc_link_id` _(required)_ + +: The identifier of the VPC link. + +## Properties + +`id` +: The identifier of the VPC link used to integrate to reference this VPC link. + +`name` +: The name used to label and identify the VPC link. + +`description` +: The description of the VPC link. + +`target_arns` +: The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner. + +`status` +: The status of the VPC link. The valid values are `AVAILABLE`, `PENDING`, `DELETING`, or `FAILED`. If the status is `PENDING`, the API deployment waits, and if the status is `DELETING`, the API deployment fails. + +`status_message` +: A description about the VPC link status. + +`tags` +: The collection of strings. Each tag element is associated with a given resource. + +## Examples + +### Test to ensure a VPC link ID is available + +```ruby +describe aws_api_gateway_vpc_link(vpc_link_id: 'VPC_LINK_ID') do + its('id') { should eq 'VPC_LINK_ID' } +end +``` + +### Test to ensure a VPC link name is available + +```ruby +describe aws_api_gateway_vpc_link(vpc_link_id: 'VPC_LINK_ID') do + its('name') { should eq 'VPC_LINK_NAME' } +end +``` + +### Test to verify the status as `AVAILABLE` + +```ruby +describe aws_api_gateway_vpc_link(vpc_link_id: 'VPC_LINK_ID') do + its('status') { should eq 'AVAILABLE' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_vpc_link(vpc_link_id: 'VPC_LINK_ID') do + it { should exist } +end +``` + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_vpc_link(vpc_link_id: 'VPC_LINK_ID') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:VpcLink" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_vpc_links.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_vpc_links.md new file mode 100644 index 0000000000..de3b4c6b7c --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_api_gateway_vpc_links.md @@ -0,0 +1,124 @@ ++++ +title = "aws_api_gateway_vpc_links resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_api_gateway_vpc_links" +identifier = "inspec/resources/aws/aws_api_gateway_vpc_links resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_api_gateway_vpc_links` InSpec audit resource to test multiple AWS API Gateway VPC link properties. + +For additional information, including parameters and properties, see the [AWS documentation on AWS APIGateway VPCLink](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html). + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +Ensure that a VPC link exists. + +```ruby +describe aws_api_gateway_vpc_links do + it { should exist } +end +``` + +## Parameters + +This resource does not require any parameters. + +## Properties + +`ids` +: The identifier of the VPC link used to integrate to reference this VPC link. + +: **Field**: `id` + +`names` +: The name used to label and identify the VPC link. + +: **Field**: `name` + +`descriptions` +: The description of the VPC link. + +: **Field**: `description` + +`target_arns` +: The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner. + +: **Field**: `target_arns` + +`statuses` +: The status of the VPC link. The valid values are `AVAILABLE`, `PENDING`, `DELETING`, or `FAILED`. If the status is `PENDING`, the API deployment waits, and if the status is `DELETING`, the API deployment fails. + +: **Field**: `status` + +`status_messages` +: A description about the VPC link status. + +: **Field**: `status_message` + +`tags` +: The collection of tags. Each tag element is associated with a given resource. + +: **Field**: `tags` + +## Examples + +### Test to ensure a VPC link ID is available + +```ruby +describe aws_api_gateway_vpc_links do + its('ids') { should include 'VPC_LINK_ID' } +end +``` + +### Test to ensure a VPC link name is available + +```ruby +describe aws_api_gateway_vpc_links do + its('names') { should include 'VPC_LINK_NAME' } +end +``` + +### Test to verify the status as `AVAILABLE` + +```ruby +describe aws_api_gateway_vpc_links do + its('statuses') { should include 'AVAILABLE' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_api_gateway_vpc_links do + it { should exist } +end +``` + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_api_gateway_vpc_links do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:VpcLinks" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_account.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_account.md index 517c4d11d5..0c6fe5be45 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_account.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_account.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::Account` resource specifies the IAM role that Amazon API G For additional information, including details on parameters and properties, see the [AWS documentation on AWS API Gateway accounts.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -71,9 +71,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -105,4 +105,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:Account" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:Account" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_api_key.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_api_key.md index 6590452899..538ae0014c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_api_key.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_api_key.md @@ -16,9 +16,9 @@ The AWS::ApiGateway::ApiKey resource creates a unique key that you can distribut For additional information, including details on parameters and properties, see the [AWS documentation on AWS APIGateway ApiKey.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -88,9 +88,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -122,4 +122,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:ApiKey" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:ApiKey" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_api_keys.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_api_keys.md index 526378b112..38458e7899 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_api_keys.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_api_keys.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::ApiKey` resource creates a unique key that you can distrib For additional information, including details on parameters and properties, see the [AWS documentation on AWS API Gateway API Key.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -106,9 +106,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -130,4 +130,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:ApiKeys" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:ApiKeys" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_authorizer.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_authorizer.md index b9e51a12bf..cd0af61cf1 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_authorizer.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_authorizer.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::Authorizer` resource creates an authorization layer that A For additional information, including details on parameters and properties, see the [AWS documentation on AWS APIGateway Authorizer.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -92,9 +92,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -126,4 +126,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:Authorizer" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:Authorizer" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_authorizers.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_authorizers.md index 3cf6da3839..6dc7dcfd65 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_authorizers.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_authorizers.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::Authorizer` resource creates an authorization layer that A For additional information, including details on parameters and properties, see the [AWS documentation on AWS APIGateway Authorizer.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -108,9 +108,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -132,4 +132,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:Authorizers" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:Authorizers" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_base_path_mapping.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_base_path_mapping.md index 0fd893ff73..b1a034d201 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_base_path_mapping.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_base_path_mapping.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::BasePathMapping` resource creates a base path that clients For additional information, including details on parameters and properties, see the [AWS documentation on AWS APIGateway BasePathMapping.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -71,9 +71,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -105,4 +105,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:BasePathMapping" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:BasePathMapping" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_base_path_mappings.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_base_path_mappings.md index e85c7313fa..0797970a1c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_base_path_mappings.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_base_path_mappings.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::BasePathMapping` resource creates a base path that clients For additional information, including details on parameters and properties, see the [AWS documentation on AWS APIGateway BasePathMapping.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -73,9 +73,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -97,4 +97,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:BasePathMappings" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:BasePathMappings" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_client_certificate.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_client_certificate.md index fa0c87ce12..c5b359f989 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_client_certificate.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_client_certificate.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::ClientCertificate` resource creates a client certificate t For additional information, including details on parameters and properties, see the [AWS documentation on AWS APIGateway ClientCertificate.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,9 +76,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:ClientCertificate" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:ClientCertificate" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_client_certificates.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_client_certificates.md index fa794655cf..1f577cac81 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_client_certificates.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_apigateway_client_certificates.md @@ -16,9 +16,9 @@ The `AWS::ApiGateway::ClientCertificate` resource creates a client certificate t For additional information, including details on parameters and properties, see the [AWS documentation on AWS API Gateway client certificate.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,9 +86,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="APIGateway:Client:ClientCertificates" %}} +{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:ClientCertificates" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scalable_target.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scalable_target.md index bac83fddcc..d281ce6315 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scalable_target.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scalable_target.md @@ -14,9 +14,9 @@ Use the `aws_application_autoscaling_scalable_target` InSpec audit resource to t For additional information, including details on parameters and properties, see the [AWS ApplicationAutoScaling ScalableTarget documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -84,7 +84,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ApplicationAutoScaling:Client:DescribeScalableTargetsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ApplicationAutoScaling:Client:DescribeScalableTargetsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scalable_targets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scalable_targets.md index 8566383886..f49afe48d2 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scalable_targets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scalable_targets.md @@ -14,9 +14,9 @@ Use the `aws_application_autoscaling_scalable_targets` InSpec audit resource to For additional information, including details on parameters and properties, see the [AWS ApplicationAutoScaling ScalableTarget documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -78,7 +78,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -104,4 +104,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ApplicationAutoScaling:Client:DescribeScalableTargetsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ApplicationAutoScaling:Client:DescribeScalableTargetsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scaling_policies.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scaling_policies.md index 53db945da1..66b149dd4d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scaling_policies.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scaling_policies.md @@ -14,9 +14,9 @@ Use the `aws_application_autoscaling_scaling_policies` InSpec audit resource to For additional information, including details on parameters and properties, see the [AWS ApplicationAutoScaling ScalingPolicy documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,7 +86,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -112,4 +112,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ApplicationAutoScaling:Client:DescribeScalingPoliciesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ApplicationAutoScaling:Client:DescribeScalingPoliciesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scaling_policy.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scaling_policy.md index a6659b31c8..40d7554cee 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scaling_policy.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_application_autoscaling_scaling_policy.md @@ -14,9 +14,9 @@ Use the `aws_application_autoscaling_scaling_policy` InSpec audit resource to te For additional information, including details on parameters and properties, see the [AWS ApplicationAutoScaling ScalingPolicy documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -143,7 +143,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -169,4 +169,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ApplicationAutoScaling:Client:DescribeScalingPoliciesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ApplicationAutoScaling:Client:DescribeScalingPoliciesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_athena_work_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_athena_work_group.md index febed3438c..be5b49f2b5 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_athena_work_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_athena_work_group.md @@ -14,9 +14,9 @@ Use the `aws_athena_work_group` InSpec audit resource to test properties of a si For additional information, including details on parameters and properties, see the [AWS Athena workgroup documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -88,7 +88,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -122,4 +122,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Athena:Client:GetWorkGroupOutput" %}} +{{% inspec-aws/aws_permissions_principal action="Athena:Client:GetWorkGroupOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_athena_work_groups.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_athena_work_groups.md index e1929e4d41..98b37c3b5c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_athena_work_groups.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_athena_work_groups.md @@ -14,9 +14,9 @@ Use the `aws_athena_work_groups` InSpec audit resource to test properties of mul For additional information, including details on parameters and properties, see the [AWS Athena workgroup documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -64,7 +64,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -98,4 +98,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Athena:Client:ListWorkGroupsOutput" %}} +{{% inspec-aws/aws_permissions_principal action="Athena:Client:ListWorkGroupsOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_auto_scaling_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_auto_scaling_group.md index 2541dbad40..efec09ee7d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_auto_scaling_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_auto_scaling_group.md @@ -14,9 +14,9 @@ Use the `aws_auto_scaling_group` InSpec audit resource to test properties of a s For additional information, including details on parameters and properties, see the [AWS documentation on Auto Scaling Group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -88,7 +88,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -110,6 +112,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="AutoScaling:Client:AutoScalingGroupsType" %}} +{{% inspec-aws/aws_permissions_principal action="AutoScaling:Client:AutoScalingGroupsType" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Auto Scaling Groups](https://docs.aws.amazon.com/autoscaling/ec2/userguide/control-access-using-iam.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_auto_scaling_groups.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_auto_scaling_groups.md index 4756b215c5..9eb9b1fabf 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_auto_scaling_groups.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_auto_scaling_groups.md @@ -14,9 +14,9 @@ Use the `aws_auto_scaling_groups` InSpec audit resource to test the properties o For additional information, including details on parameters and properties, see the [AWS documentation on Auto Scaling Group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -71,7 +71,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist @@ -93,5 +93,5 @@ end ## AWS Permissions -{{% aws_permissions_principal action="AutoScaling:Client:AutoScalingGroupsType" %}} +{{% inspec-aws/aws_permissions_principal action="AutoScaling:Client:AutoScalingGroupsType" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Auto Scaling Groups](https://docs.aws.amazon.com/autoscaling/ec2/userguide/control-access-using-iam.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_autoscaling_scaling_policies.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_autoscaling_scaling_policies.md index 1b6eb68940..e9ef0f652f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_autoscaling_scaling_policies.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_autoscaling_scaling_policies.md @@ -14,9 +14,9 @@ Use the `aws_autoscaling_scaling_policies` InSpec audit resource to test propert For additional information, including details on parameters and properties, see the [AWS AutoScaling Scaling Policy documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -93,7 +93,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -126,4 +126,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="AutoScaling:client:PoliciesType" %}} +{{% inspec-aws/aws_permissions_principal action="AutoScaling:client:PoliciesType" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_autoscaling_scaling_policy.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_autoscaling_scaling_policy.md index 5a0b449966..460aacd4fb 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_autoscaling_scaling_policy.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_autoscaling_scaling_policy.md @@ -14,9 +14,9 @@ Use the `aws_autoscaling_scaling_policy` InSpec audit resource to test propertie For additional information, including details on parameters and properties, see the [AWS AutoScaling Scaling Policy documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -101,7 +101,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -135,4 +135,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="AutoScaling:client:PoliciesType" %}} +{{% inspec-aws/aws_permissions_principal action="AutoScaling:client:PoliciesType" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_compute_environment.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_compute_environment.md index 4a9838ec28..577df5604f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_compute_environment.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_compute_environment.md @@ -14,9 +14,9 @@ Use the `aws_batch_compute_environment` InSpec audit resource to test the proper For additional information, including details on parameters and properties, see the [AWS documentation on Batch compute environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -136,7 +136,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -170,4 +170,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Batch:Client:DescribeComputeEnvironmentsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Batch:Client:DescribeComputeEnvironmentsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_compute_environments.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_compute_environments.md index 509135a61b..3dd5410e5b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_compute_environments.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_compute_environments.md @@ -14,9 +14,9 @@ Use the `aws_batch_compute_environments` InSpec audit resource to test propertie For additional information, including details on parameters and properties, see the [AWS documentation on Batch compute environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -115,4 +115,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Batch:Client:DescribeComputeEnvironmentsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Batch:Client:DescribeComputeEnvironmentsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_definition.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_definition.md index 7e196a8c94..9a0721060f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_definition.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_definition.md @@ -16,9 +16,9 @@ The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch For additional information, including details on parameters and properties, see the [AWS documentation on Batch Job Definition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -163,7 +163,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -197,4 +197,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Batch:Client:DescribeJobDefinitionsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Batch:Client:DescribeJobDefinitionsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_definitions.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_definitions.md index 1cf13b138c..98fb1290bd 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_definitions.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_definitions.md @@ -16,9 +16,9 @@ The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch For additional information, including details on parameters and properties, see the [AWS documentation on Batch Job Definition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -117,4 +117,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Batch:Client:DescribeJobDefinitionsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Batch:Client:DescribeJobDefinitionsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_queue.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_queue.md index 5084480f0d..78674b3371 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_queue.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_queue.md @@ -14,9 +14,9 @@ Use the `aws_batch_job_queue` InSpec audit resource to test the properties of a For additional information, including details on parameters and properties, see the [AWS Batch job queues documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -83,7 +83,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -117,4 +117,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Batch:Client:DescribeJobQueuesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Batch:Client:DescribeJobQueuesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_queues.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_queues.md index a15b164b30..08f8546b8c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_queues.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_batch_job_queues.md @@ -14,9 +14,9 @@ Use the `aws_batch_job_queues` InSpec audit resource to test the properties of m For additional information, including details on parameters and properties, see the [AWS Batch job queues documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -75,7 +75,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -109,4 +109,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Batch:Client:DescribeJobQueuesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Batch:Client:DescribeJobQueuesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloud_formation_stack_set.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloud_formation_stack_set.md index 5949661adc..83f64eda4c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloud_formation_stack_set.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloud_formation_stack_set.md @@ -14,9 +14,9 @@ Use the `aws_cloud_formation_stack_set` InSpec audit resource to test properties For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudFormation stack set](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -151,7 +151,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -177,4 +177,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFormation:Client:DescribeStackSetOutput" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFormation:Client:DescribeStackSetOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloud_formation_stack_sets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloud_formation_stack_sets.md index a9849b22fa..c7770da624 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloud_formation_stack_sets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloud_formation_stack_sets.md @@ -14,9 +14,9 @@ Use the `aws_cloud_formation_stack_sets` InSpec audit resource to test propertie For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudFormation Stack Set.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -94,7 +94,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -118,4 +118,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFormation:Client:ListStackSetsOutput" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFormation:Client:ListStackSetsOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudformation_stack.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudformation_stack.md index c4416ef510..a722158984 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudformation_stack.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudformation_stack.md @@ -14,9 +14,9 @@ Use the `aws_cloudformation_stack ` InSpec audit resource to test properties of For additional information, including details on parameters and properties, see the [AWS documentation on Cloud Formation](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/Welcome.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -121,7 +121,9 @@ end ## Matchers -This InSpec audit resource has no special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -143,6 +145,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFormation:Client:DescribeStacksOutput" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFormation:Client:DescribeStacksOutput" %}} You can find detailed documentation at [Authentication and Access Control for CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html) diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudformation_stacks.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudformation_stacks.md index f330e3cb16..2849852e58 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudformation_stacks.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudformation_stacks.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_cloudformation_stacks` InSpec audit resource to test properties of an AWS CloudFormation stack in bulk. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -81,7 +81,9 @@ end ## Matchers -This InSpec audit resource has no special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -103,6 +105,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFormation:Client:DescribeStacksOutput" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFormation:Client:DescribeStacksOutput" %}} You can find detailed documentation at [Authentication and Access Control for CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html) diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudformation_template.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudformation_template.md index 89c17d6d57..ae9af9a6f6 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudformation_template.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudformation_template.md @@ -16,9 +16,9 @@ The above resource returns information about a new or existing template. For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudFormation templates](https://aws.amazon.com/cloudformation/resources/templates/). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -164,9 +164,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -222,4 +222,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFormation:Client:GetTemplateSummaryOutput" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFormation:Client:GetTemplateSummaryOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_cache_policies.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_cache_policies.md index b3f4862a71..3b6d5e734f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_cache_policies.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_cache_policies.md @@ -14,9 +14,9 @@ Use the `aws_cloudfront_cache_policies` InSpec audit resource to test properties The `AWS::CloudFront::CachePolicy` resource describes the CloudFront cache policy. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -94,7 +94,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -118,4 +118,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:ListCachePoliciesResult" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:ListCachePoliciesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_cache_policy.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_cache_policy.md index 2b58e684ea..7e048e9493 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_cache_policy.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_cache_policy.md @@ -14,9 +14,9 @@ Use the `aws_cloudfront_cache_policy` InSpec audit resource to test properties o The `AWS::CloudFront::CachePolicy` resource describes the CloudFront cache policy. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -112,9 +112,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -146,4 +146,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:GetCachePolicyResult" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:GetCachePolicyResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_distribution.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_distribution.md index eafa19cce6..e52f42b697 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_distribution.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_distribution.md @@ -14,9 +14,9 @@ Use the `aws_cloudfront_distribution` InSpec audit resource to test the properti For additional information, including details on parameters and properties, see the [AWS API reference for CloudFront distributions](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_distribution.html) documentation. For available SSL/TLS version identifiers, see [OriginSslProtocols](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_OriginSslProtocols.html) and [AWS::CloudFront::distribution ViewerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html) documentation. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -102,7 +102,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### have_viewer_protocol_policies_allowing_http @@ -188,6 +190,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:GetDistributionResult" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:GetDistributionResult" %}} You can find detailed documentation at [Identity and Access Management (IAM) in CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/auth-and-access-control.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_distributions.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_distributions.md index e9edaeea82..93c77bf6da 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_distributions.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_distributions.md @@ -14,9 +14,9 @@ Use the `aws_cloudfront_distributions` InSpec audit resource to test the propert For additional information, including details on parameters and properties, see the [AWS API reference for CloudFront distributions](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_distribution.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -93,7 +93,9 @@ end ## Matchers -This InSpec audit resource has no special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -109,6 +111,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:ListDistributionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:ListDistributionsResult" %}} You can find detailed documentation at [Identity and Access Management (IAM) in CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/auth-and-access-control.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_key_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_key_group.md index 65ef5347b0..a5179c37e6 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_key_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_key_group.md @@ -14,9 +14,9 @@ Use the `aws_cloudfront_key_group` InSpec audit resource to test properties of a For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudFront key group.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keygroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -71,9 +71,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -105,4 +105,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:GetKeyGroupResult" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:GetKeyGroupResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_key_groups.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_key_groups.md index ebf157b214..51b9244958 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_key_groups.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_key_groups.md @@ -14,9 +14,9 @@ Use the `aws_cloudfront_key_groups` InSpec audit resource to test properties of For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudFront key group.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keygroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -79,7 +79,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -103,4 +103,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:ListKeyGroupsResult" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:ListKeyGroupsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_origin_access_identities.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_origin_access_identities.md index fcd4c02ec4..792d30f490 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_origin_access_identities.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_origin_access_identities.md @@ -16,9 +16,9 @@ An origin access identity is a special CloudFront user that you can associate wi For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudFront CloudFrontOriginAccessIdentity.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,7 +76,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -100,4 +100,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:ListCloudFrontOriginAccessIdentitiesResult" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:ListCloudFrontOriginAccessIdentitiesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_origin_access_identity.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_origin_access_identity.md index 995ae1fd63..2ab67b5ece 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_origin_access_identity.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_origin_access_identity.md @@ -16,9 +16,9 @@ An origin access identity is a special CloudFront user that you can associate wi For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudFront CloudFrontOriginAccessIdentity.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -70,9 +70,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -104,4 +104,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:GetCloudFrontOriginAccessIdentityResult" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:GetCloudFrontOriginAccessIdentityResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_origin_request_policy.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_origin_request_policy.md index 23184329e1..ae7d8e3f11 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_origin_request_policy.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_origin_request_policy.md @@ -14,9 +14,9 @@ Use the `aws_cloudfront_origin_request_policy` InSpec audit resource to test pro For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudFront origin request policy.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originrequestpolicy.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -95,9 +95,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -129,4 +129,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:GetOriginRequestPolicyResult" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:GetOriginRequestPolicyResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_public_key.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_public_key.md index 976cf7c0b7..a7861b2bf5 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_public_key.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_public_key.md @@ -16,9 +16,9 @@ The `AWS::CloudFront::PublicKey` resource type creates a public key that you can For additional information, including details on parameters and properties, see the [AWS documentation on AWS Logs public key.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-publickey.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,9 +76,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:GetPublicKeyResult" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:GetPublicKeyResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_public_keys.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_public_keys.md index 5b5c9a7a78..c2de363425 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_public_keys.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_public_keys.md @@ -16,9 +16,9 @@ The `AWS::CloudFront::PublicKey` resource type creates a public key that you can For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudFront public key.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-publickey.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,7 +86,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:ListPublicKeysResult" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:ListPublicKeysResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_realtime_log_config.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_realtime_log_config.md index b425386a65..c587085eb6 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_realtime_log_config.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_realtime_log_config.md @@ -16,9 +16,9 @@ The `AWS::CloudFront::RealtimeLogConfig` resource creates a real-time log config For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudFront RealtimeLogConfig.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -98,9 +98,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -132,4 +132,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:GetRealtimeLogConfigResult" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:GetRealtimeLogConfigResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_realtime_log_configs.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_realtime_log_configs.md index beefc7fd4d..5c5866af80 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_realtime_log_configs.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_realtime_log_configs.md @@ -16,9 +16,9 @@ The `AWS::CloudFront::RealtimeLogConfig` resource creates a real-time log config For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudFront RealtimeLogConfig.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -81,7 +81,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -115,4 +115,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:ListRealtimeLogConfigsResult" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:ListRealtimeLogConfigsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_streaming_distribution.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_streaming_distribution.md index 307cc4a89f..f963c58dbb 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_streaming_distribution.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_streaming_distribution.md @@ -14,9 +14,9 @@ Use the `aws_cloudfront_streaming_distribution` InSpec audit resource to test pr For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudFront streaming distribution.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-streamingdistribution.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -131,9 +131,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -165,4 +165,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:GetStreamingDistributionResult" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:GetStreamingDistributionResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_streaming_distributions.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_streaming_distributions.md index d1ecd4faed..32fd75c8da 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_streaming_distributions.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudfront_streaming_distributions.md @@ -14,9 +14,9 @@ Use the `aws_cloudfront_streaming_distributions` InSpec audit resource to test p For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudFront streaming distribution.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-streamingdistribution.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -109,7 +109,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -133,4 +133,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:ListStreamingDistributionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:ListStreamingDistributionsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudtrail_trail.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudtrail_trail.md index 46b5bf28aa..d5d81dbe0e 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudtrail_trail.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudtrail_trail.md @@ -10,26 +10,28 @@ identifier = "inspec/resources/aws/aws_cloudtrail_trail Resource" parent = "inspec/resources/aws" +++ -Use the `aws_cloudtrail_trail` InSpec audit resource to test properties of a single AWS CloudTrail. +Use the `aws_cloudtrail_trail` Chef InSpec audit resource to test properties of a single AWS CloudTrail trail. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax -An `aws_cloudtrail_trail` resource block identifies a trail by `trail_name`. +An `aws_cloudtrail_trail` resource block identifies a trail by `TRAIL_NAME`. + +**Find a trail by name:** - # Find a trail by name ```ruby -describe aws_cloudtrail_trail('trail-name') do +describe aws_cloudtrail_trail('TRAIL_NAME') do it { should exist } end ``` - # Hash syntax for trail name +**Use hash syntax to find a trail by trail name:** + ```ruby -describe aws_cloudtrail_trail(trail_name: 'trail-name') do +describe aws_cloudtrail_trail(trail_name: 'TRAIL_NAME') do it { should exist } end ``` @@ -37,17 +39,17 @@ end ## Parameters `trail_name` _(required)_ -: This resource expects a single parameter, the CloudTrail Name which uniquely identifies it. +: This resource expects a single parameter, the CloudTrail name which uniquely identifies it. This can be passed either as a string or as a `trail_name: 'value'` key-value entry in a hash. -See also the [AWS documentation on CloudTrail](https://docs.aws.amazon.com/cloudtrail/index.html#lang/en_us). +See the [AWS documentation on CloudTrail](https://docs.aws.amazon.com/cloudtrail/index.html#lang/en_us). ## Properties `trail_arn` : Specifies the ARN of the trail. -`trail_name` +`TRAIL_NAME` : Name of the trail. `home_region` @@ -65,18 +67,24 @@ See also the [AWS documentation on CloudTrail](https://docs.aws.amazon.com/cloud `kms_key_id` : Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. +`s3_key_prefix` +: Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. + +`is_organization_trail` +: Specifies whether the trail is an organization trail. It returns boolean value. + ## Examples **Test that the specified trail does exist.** ```ruby -describe aws_cloudtrail_trail('my-cloudtrail') do +describe aws_cloudtrail_trail('TRAIL_NAME') do it { should exist } end ``` ```ruby -describe aws_cloudtrail_trail(trail_name: 'my-cloudtrail') do +describe aws_cloudtrail_trail(trail_name: 'TRAIL_NAME') do it { should exist } end ``` @@ -84,15 +92,15 @@ end **Check the KMS key used to encrypt.** ```ruby -describe aws_cloudtrail_trail('my-cloudtrail') do - its('kms_key_id') { should eq "my-kms-key" } +describe aws_cloudtrail_trail('TRAIL_NAME') do + its('kms_key_id') { should eq "KMS_KEY_ID" } end ``` -**Check the Home Region is correct.** +**Check the home region is correct.** ```ruby -describe aws_cloudtrail_trail('my-cloudtrail') do +describe aws_cloudtrail_trail('TRAIL_NAME') do its('home_region') { should eq 'us-east-1' } end ``` @@ -100,60 +108,94 @@ end **Test that the specified trail is a multi-region trail.** ```ruby -describe aws_cloudtrail_trail('my-cloudtrail') do +describe aws_cloudtrail_trail('TRAIL_NAME') do it { should be_multi_region_trail } end ``` +**Test that the specified trail is an organization trail.** + +```ruby +describe aws_cloudtrail_trail('TRAIL_NAME') do + its("is_organization_trail") { should eq true } + it { should be_organization_trail } +end +``` + +**Test that the specified trail has a S3 Key Prefix.** + +```ruby +describe aws_cloudtrail_trail('TRAIL_NAME') do + its("s3_key_prefix") { should eq 'S3_KEY_PREFIX_NAME' } +end +``` + ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -### exist +This resource has the following special matchers. -The control will pass if the describe returns at least one result. +### exist -Use `should_not` to test the entity should not exist. +Use `should` with the `exist` matcher to verify that the CloudTrail trail exists. - # Verify that at least one CloudTrail Trail exists. ```ruby -describe aws_cloudtrail_trail('my-cloudtrail') do +describe aws_cloudtrail_trail('TRAIL_NAME') do it { should exist } end ``` -#### be_multi_region_trail +Use `should_not` to verify that a CloudTrail trail does not exists. + +```ruby +describe aws_cloudtrail_trail('TRAIL_NAME') do + it { should_not exist } +end +``` + +### be_multi_region_trail The test will pass if the identified trail is a multi-region trail. ```ruby -describe aws_cloudtrail_trail('my-cloudtrail') do +describe aws_cloudtrail_trail('TRAIL_NAME') do it { should be_multi_region_trail } end ``` -#### be_encrypted +### be_encrypted The test will pass if the logs delivered by the identified trail are encrypted. ```ruby -describe aws_cloudtrail_trail('my-cloudtrail') do +describe aws_cloudtrail_trail('TRAIL_NAME') do it { should be_encrypted } end ``` -#### be_log_file_validation_enabled +### be_log_file_validation_enabled -The test will pass if the identified trail has log file integrity validation is enabled. +The test will pass if the identified trail has log file integrity validation enabled. ```ruby -describe aws_cloudtrail_trail('my-cloudtrail') do +describe aws_cloudtrail_trail('TRAIL_NAME') do it { should be_log_file_validation_enabled } end ``` +### be_organization_trail + +The test will pass if the identified trail has organization trail is enabled. + +```ruby +describe aws_cloudtrail_trail('TRAIL_NAME') do + it { should be_organization_trail } +end +``` + ## AWS Permissions -{{% aws_permissions_principal action="CloudTrail:Client:DescribeTrailsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CloudTrail:Client:DescribeTrailsResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for AWS CloudTrail](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awscloudtrail.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudtrail_trails.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudtrail_trails.md index 9e30f51973..a1fca9ce7b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudtrail_trails.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudtrail_trails.md @@ -14,9 +14,9 @@ Use the `aws_cloudtrail_trails` InSpec audit resource to test properties of a co For additional information, including details on parameters and properties, see the [AWS documentation on Auto Scaling Group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -63,7 +63,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -85,6 +87,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudTrail:Client:DescribeTrailsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CloudTrail:Client:DescribeTrailsResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for AWS CloudTrail](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awscloudtrail.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_alarm.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_alarm.md index 49489283ad..48920811aa 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_alarm.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_alarm.md @@ -14,9 +14,9 @@ Use the `aws_cloudwatch_alarm` InSpec audit resource to test properties of a sin **If more than one Alarm matches, an error will be raised.** -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,7 +76,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -98,6 +100,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatch:Client:DescribeAlarmsForMetricOutput" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatch:Client:DescribeAlarmsForMetricOutput" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon CloudWatch](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_anomaly_detector.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_anomaly_detector.md index 607feaa749..580a1a0ce3 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_anomaly_detector.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_anomaly_detector.md @@ -16,9 +16,9 @@ The `AWS::CloudWatch::AnomalyDetector` type specifies an anomaly detection band For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudWatch AnomalyDetector.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -96,7 +96,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -130,4 +130,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatch:Client:DescribeAnomalyDetectorsOutput" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatch:Client:DescribeAnomalyDetectorsOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_anomaly_detectors.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_anomaly_detectors.md index fa81f5b7e5..cf4f946a20 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_anomaly_detectors.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_anomaly_detectors.md @@ -16,9 +16,9 @@ The `AWS::CloudWatch::AnomalyDetector` type specifies an anomaly detection band For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudWatch AnomalyDetector.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-anomalydetector.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,7 +86,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -120,4 +120,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatch:Client:DescribeAnomalyDetectorsOutput" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatch:Client:DescribeAnomalyDetectorsOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_composite_alarm.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_composite_alarm.md index 616ac34e9a..0c0189f6c6 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_composite_alarm.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_composite_alarm.md @@ -16,9 +16,9 @@ The `AWS::CloudWatch::CompositeAlarm` resource type creates or updates a composi For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudWatch composite alarm.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -105,7 +105,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -139,4 +139,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatch:Client:DescribeAlarmsOutput" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatch:Client:DescribeAlarmsOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_composite_alarms.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_composite_alarms.md index 73fdb15dfd..754e0d9aa6 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_composite_alarms.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_composite_alarms.md @@ -16,9 +16,9 @@ The `AWS::CloudWatch::CompositeAlarm` resource type creates or updates a composi For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudWatch composite alarm.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -129,7 +129,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -153,4 +153,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatch:Client:DescribeAlarmsOutput" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatch:Client:DescribeAlarmsOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_dashboard.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_dashboard.md index 8b950c78d4..39394dc30d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_dashboard.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_dashboard.md @@ -14,9 +14,9 @@ Use the `aws_cloudwatch_dashboard` InSpec audit resource to test properties of t For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudWatch Dashboard.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -65,9 +65,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -89,4 +89,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatch:Client:GetDashboardOutput" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatch:Client:GetDashboardOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_dashboards.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_dashboards.md index 0b710135fa..e672e1d579 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_dashboards.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_dashboards.md @@ -14,9 +14,9 @@ Use the `aws_cloudwatch_dashboards` InSpec audit resource to test properties of For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudWatch dashboard.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -74,7 +74,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -98,4 +98,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatch:Client:ListDashboardsOutput" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatch:Client:ListDashboardsOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_insight_rules.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_insight_rules.md index 399673cf99..3eccc2806f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_insight_rules.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_insight_rules.md @@ -14,9 +14,9 @@ Use the `aws_cloudwatch_insight_rules` InSpec audit resource to test properties For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudWatch Insight rules.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -74,7 +74,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -98,4 +98,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatch:Client:DescribeInsightRulesOutput" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatch:Client:DescribeInsightRulesOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_log_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_log_group.md index 41ec63b589..be7af47ee5 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_log_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_log_group.md @@ -14,9 +14,9 @@ Use the `aws_cloudwatch_log_group` InSpec audit resource to test properties of a For additional information, including details on parameters and properties, see the [AWS documentation on CloudWatch Logs](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeLogGroups.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -41,6 +41,11 @@ end : This resource accepts a single parameter, the log group name which uniquely identifies the CloudWatch Log Group. This can be passed either as a string or as a `log_group_name: 'value'` key-value entry in a hash. +`limit` _(optional)_ + +: This resource accepts a single parameter, an integer representing the number of results allowed to return. If not passed, in, this defaults to `1`, which will only return the first match to the `log_group_name`. + This can be passed as a `limit: 'value'` key-value entry in a hash. + ## Properties `retention_in_days` diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_log_metric_filter.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_log_metric_filter.md index 3a3ba5865c..ffa3505628 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_log_metric_filter.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_log_metric_filter.md @@ -14,9 +14,9 @@ Use the `aws_cloudwatch_log_metric_filter` InSpec audit resource to search for a For additional information, including details on parameters and properties, see the [AWS documentation on CloudWatch](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -110,7 +110,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -132,6 +134,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatchLogs:Client:DescribeMetricFiltersResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatchLogs:Client:DescribeMetricFiltersResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon CloudWatch](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_metric_stream.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_metric_stream.md index 1fa26a6bde..3c93e729f9 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_metric_stream.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_metric_stream.md @@ -14,9 +14,9 @@ Use the `aws_cloudwatch_metric_stream` InSpec audit resource to test properties For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudWatch metric stream.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -75,9 +75,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -99,4 +99,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:GetMetricStreamsOutput" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:GetMetricStreamsOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_metric_streams.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_metric_streams.md index 7323aaccdd..60ee4b79e0 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_metric_streams.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatch_metric_streams.md @@ -14,9 +14,9 @@ Use the `aws_cloudwatch_metric_streams` InSpec audit resource to test properties For additional information, including details on parameters and properties, see the [AWS documentation on AWS CloudWatch metric stream.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -89,7 +89,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -113,4 +113,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudFront:Client:ListMetricStreamsOutput" %}} +{{% inspec-aws/aws_permissions_principal action="CloudFront:Client:ListMetricStreamsOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_destination.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_destination.md index 89a890be63..e8b3812554 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_destination.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_destination.md @@ -16,9 +16,9 @@ The `AWS::Logs::Destination` resource type specifies a CloudWatch Logs destinati For additional information, including details on parameters and properties, see the [AWS documentation on AWS::Logs::Destination.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,7 +76,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatchLogs:Client:DescribeDestinationsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatchLogs:Client:DescribeDestinationsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_destinations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_destinations.md index a557f02cff..1ce0906f86 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_destinations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_destinations.md @@ -16,9 +16,9 @@ The `AWS::Logs::Destination` resource type specifies a CloudWatch Logs destinati For additional information, including details on parameters and properties, see the [AWS documentation on AWS::Logs::Destination.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,7 +86,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatchLogs:Client:DescribeDestinationsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatchLogs:Client:DescribeDestinationsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_log_stream.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_log_stream.md index fb842bb401..c1328cf0da 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_log_stream.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_log_stream.md @@ -16,9 +16,9 @@ The AWS::Logs::LogStream resource specifies an Amazon CloudWatch Logs log stream For additional information, including details on parameters and properties, see the [AWS documentation on AWS Logs LogStream.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,7 +86,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -120,4 +120,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatchLogs:Client:DescribeLogStreamsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatchLogs:Client:DescribeLogStreamsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_log_streams.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_log_streams.md index d790758f5e..6f189f51de 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_log_streams.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_log_streams.md @@ -16,9 +16,9 @@ The AWS::Logs::LogStream resource specifies an Amazon CloudWatch Logs log stream For additional information, including details on parameters and properties, see the [AWS documentation on AWS Logs LogStream.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -98,7 +98,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -122,4 +122,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatchLogs:Client:DescribeLogStreamsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatchLogs:Client:DescribeLogStreamsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_subscription_filter.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_subscription_filter.md index 533c04e56c..87b819ab2a 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_subscription_filter.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_subscription_filter.md @@ -16,9 +16,9 @@ The AWS::Logs::SubscriptionFilter specifies a subscription filter and associates For additional information, including details on parameters and properties, see the [AWS documentation on AWS Logs SubscriptionFilter.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -83,7 +83,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -117,4 +117,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatchLogs:Client:DescribeSubscriptionFiltersResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatchLogs:Client:DescribeSubscriptionFiltersResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_subscription_filters.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_subscription_filters.md index 39a455def0..615ea11dcd 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_subscription_filters.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cloudwatchlogs_subscription_filters.md @@ -16,9 +16,9 @@ The AWS::Logs::SubscriptionFilter specifies a subscription filter and associates For additional information, including details on parameters and properties, see the [AWS documentation on AWS Logs SubscriptionFilter.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -93,7 +93,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -127,4 +127,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatchLogs:Client:DescribeSubscriptionFiltersResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatchLogs:Client:DescribeSubscriptionFiltersResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_identity_pool.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_identity_pool.md index b5ba02e454..00e154f881 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_identity_pool.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_identity_pool.md @@ -14,9 +14,9 @@ Use the `aws_cognito_identity_pool` InSpec audit resource to test properties of For additional information, including details on parameters and properties, see the [AWS documentation on Cognito identity pool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,7 +86,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -120,4 +120,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CognitoIdentity:Client:IdentityPool" %}} +{{% inspec-aws/aws_permissions_principal action="CognitoIdentity:Client:IdentityPool" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_identity_pools.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_identity_pools.md index ffe3f66ff0..90ca28803e 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_identity_pools.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_identity_pools.md @@ -14,9 +14,9 @@ Use the `aws_cognito_identity_pools` InSpec audit resource to test properties of For additional information, including details on parameters and properties, see the [AWS documentation on Cognito identity pool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -60,7 +60,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -91,4 +91,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CognitoIdentity:Client:ListIdentityPoolsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CognitoIdentity:Client:ListIdentityPoolsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpool.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpool.md index 04f8dfa353..144b454882 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpool.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpool.md @@ -14,9 +14,9 @@ Use the `aws_cognito_userpool` InSpec audit resource to test properties of a sin For additional information, including details on parameters and properties, see the [AWS documentation on Cognito user pool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -140,7 +140,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -174,4 +174,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CognitoIdentityProvider:Client:DescribeUserPoolResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CognitoIdentityProvider:Client:DescribeUserPoolResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpool_client.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpool_client.md index fd7e3cbfdb..7c2c804c30 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpool_client.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpool_client.md @@ -14,9 +14,9 @@ Use the `aws_cognito_userpool_client` InSpec audit resource to test properties o For additional information, including details on parameters and properties, see the [AWS documentation on Cognito user pool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -145,7 +145,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -179,4 +179,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CognitoIdentityProvider:Client:DescribeUserPoolClientResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CognitoIdentityProvider:Client:DescribeUserPoolClientResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpool_clients.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpool_clients.md index 1c8dbbb46a..4d41975bb8 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpool_clients.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpool_clients.md @@ -14,9 +14,9 @@ Use the `aws_cognito_userpool_clients` InSpec audit resource to test properties For additional information, including details on parameters and properties, see the [AWS documentation on Cognito user pool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -63,7 +63,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -97,4 +97,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CognitoIdentityProvider:Client:ListUserPoolClientsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CognitoIdentityProvider:Client:ListUserPoolClientsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpools.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpools.md index d08b905bbe..c8310a5f0b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpools.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_cognito_userpools.md @@ -14,9 +14,9 @@ Use the `aws_cognito_userpools` InSpec audit resource to test properties of mult For additional information, including details on parameters and properties, see the [AWS documentation on Cognito user pool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -72,7 +72,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -106,4 +106,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CognitoIdentityProvider:Client:ListUserPoolsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CognitoIdentityProvider:Client:ListUserPoolsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_config_delivery_channel.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_config_delivery_channel.md index 7e7f4a97c7..230be75416 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_config_delivery_channel.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_config_delivery_channel.md @@ -19,9 +19,9 @@ One delivery channel is allowed per region per AWS account, and the delivery cha For additional information, including details on parameters and properties, see the [AWS documentation on Delivery Channels](https://docs.aws.amazon.com/config/latest/developerguide/manage-delivery-channel.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -110,6 +110,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ConfigService:Client:DescribeDeliveryChannelsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ConfigService:Client:DescribeDeliveryChannelsResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for AWS Config](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awsconfig.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_config_recorder.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_config_recorder.md index ae6a67fc3e..325b9841c4 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_config_recorder.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_config_recorder.md @@ -18,9 +18,9 @@ As of April 2018, you are only permitted one configuration recorder per region. For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::Config::ConfigurationRecorder` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -134,6 +134,6 @@ it { should be_recording_all_global_types } ## AWS Permissions -{{% aws_permissions_principal action="ConfigService:Client:DescribeConfigurationRecordersResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ConfigService:Client:DescribeConfigurationRecordersResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for AWS Config](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awsconfig.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_parameter_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_parameter_group.md index 56ec503c2f..212bdeba8f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_parameter_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_parameter_group.md @@ -18,9 +18,9 @@ This resource accepts a single parameter, the DB parameter group name. This can For additional information, including details on parameters and properties, see the [AWS documentation on DB parameter groups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -66,7 +66,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -88,6 +90,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DBParameterGroupsMessage" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DBParameterGroupsMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon RDS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonrds.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_parameter_groups.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_parameter_groups.md index 234444a67f..5e88e16d5f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_parameter_groups.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_parameter_groups.md @@ -16,9 +16,9 @@ This resource does not expect any parameters. For additional information, including details on parameters and properties, see the [AWS documentation on DB parameter groups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -62,7 +62,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -84,6 +86,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DBParameterGroupsMessage" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DBParameterGroupsMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon RDS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonrds.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_subnet_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_subnet_group.md index 902794648f..7a2688e539 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_subnet_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_subnet_group.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_db_subnet_group` InSpec audit resource to test properties of a db subnet group. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -34,7 +34,7 @@ end : This resource accepts a single parameter, the DB Subnet Group Name. This can be passed either as a string or as a `aws_db_subnet_group: 'value'` key-value entry in a hash. -See also the [AWS documentation on DB Subnet Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets). +See the [AWS documentation on DB Subnet Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets). ## Properties @@ -71,7 +71,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -93,6 +95,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DBSubnetGroupMessage" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DBSubnetGroupMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon RDS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonrds.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_subnet_groups.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_subnet_groups.md index 348325f4da..5d0574d5c4 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_subnet_groups.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_db_subnet_groups.md @@ -14,9 +14,9 @@ Use the `aws_db_subnet_groups` InSpec audit resource to test properties of a col RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -66,7 +66,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -88,6 +90,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DBSubnetGroupMessage" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DBSubnetGroupMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon RDS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonrds.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dhcp_options.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dhcp_options.md index dc56a6254b..974f7e5ff0 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dhcp_options.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dhcp_options.md @@ -17,9 +17,9 @@ Use the `aws_dhcp_options` InSpec audit resource to test properties of a single For additional information, including details on parameters and properties, see the [AWS documentation on EC2](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeDhcpOptions.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -71,6 +71,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeDhcpOptionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeDhcpOptionsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_endpoint.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_endpoint.md index fc373f7548..45e289aa09 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_endpoint.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_endpoint.md @@ -14,9 +14,9 @@ Use the `aws_dms_endpoint` InSpec audit resource to test properties of a single For additional information, including details on parameters and properties, see the [AWS documentation on DMS endpoints](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -155,7 +155,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -189,4 +189,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="DatabaseMigrationService:Client:DescribeEndpointsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="DatabaseMigrationService:Client:DescribeEndpointsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_endpoints.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_endpoints.md index b93a4210ff..08d9f8abf3 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_endpoints.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_endpoints.md @@ -14,9 +14,9 @@ Use the `aws_dms_endpoints` InSpec audit resource to test properties of a single For additional information, including details on parameters and properties, see the [AWS documentation on DMS Endpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -153,7 +153,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -187,4 +187,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="DatabaseMigrationService:Client:DescribeEndpointsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="DatabaseMigrationService:Client:DescribeEndpointsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_instance.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_instance.md index b143ac1f43..c634b55c10 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_instance.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_instance.md @@ -16,9 +16,9 @@ The AWS::DMS::ReplicationInstance resource creates an AWS DMS replication instan For additional information, including details on parameters and properties, see the [AWS documentation on DMS replication instances](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -83,7 +83,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -117,4 +117,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="DatabaseMigrationService:Client:DescribeOrderableReplicationInstancesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="DatabaseMigrationService:Client:DescribeOrderableReplicationInstancesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_instances.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_instances.md index 7800bc17a5..ffdba0cd9b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_instances.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_instances.md @@ -16,9 +16,9 @@ The AWS::DMS::ReplicationInstance resource creates an AWS DMS replication instan For additional information, including details on parameters and properties, see the [AWS documentation on DMS Replication Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -83,7 +83,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -117,4 +117,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="DatabaseMigrationService:Client:DescribeOrderableReplicationInstancesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="DatabaseMigrationService:Client:DescribeOrderableReplicationInstancesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_subnet_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_subnet_group.md index a59f9f3548..e8ae3133ce 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_subnet_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_subnet_group.md @@ -14,9 +14,9 @@ Use the `aws_dms_replication_subnet_group` InSpec audit resource to test propert For additional information, including details on parameters and properties, see the [AWS documentation on DMS Replication Subnet Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -71,7 +71,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -105,4 +105,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="DatabaseMigrationService:Client:DescribeReplicationSubnetGroupsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="DatabaseMigrationService:Client:DescribeReplicationSubnetGroupsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_subnet_groups.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_subnet_groups.md index 6839960a80..ad999a0b73 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_subnet_groups.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dms_replication_subnet_groups.md @@ -14,9 +14,9 @@ Use the `aws_dms_replication_subnet_groups` InSpec audit resource to test proper For additional information, including details on parameters and properties, see the [AWS documentation on DMS Replication Subnet Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -69,7 +69,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -103,4 +103,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="DatabaseMigrationService:Client:DescribeReplicationSubnetGroupsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="DatabaseMigrationService:Client:DescribeReplicationSubnetGroupsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dynamodb_table.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dynamodb_table.md index 27c64f2323..9b6ceec950 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dynamodb_table.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dynamodb_table.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_dynamodb_table` InSpec audit resource to test properties of a single DynamoDb Table. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -120,7 +120,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. #### be_encrypted @@ -150,6 +152,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="DynamoDB:Client:DescribeTableOutput" %}} +{{% inspec-aws/aws_permissions_principal action="DynamoDB:Client:DescribeTableOutput" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Dynamodb](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazondynamodb.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dynamodb_tables.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dynamodb_tables.md index 23d8f93ccb..67f4c75774 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dynamodb_tables.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_dynamodb_tables.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_dynamodb_table` InSpec audit resource to test properties of a collection of AWS DynamoDB Table. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -72,7 +72,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -96,6 +98,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="DynamoDB:Client:ListTablesOutput" %}} +{{% inspec-aws/aws_permissions_principal action="DynamoDB:Client:ListTablesOutput" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Dynamodb](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazondynamodb.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_snapshot.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_snapshot.md index 06ba7ebce2..421e00c727 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_snapshot.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_snapshot.md @@ -15,9 +15,9 @@ incremental backups of AWS EBS volumes that are saved to AWS S3. For additional information, including details on parameters and properties, see the [AWS documentation on EBS Snapshots](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -132,7 +132,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_snapshots.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_snapshots.md index 874be2c536..cb3bb78de2 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_snapshots.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_snapshots.md @@ -14,9 +14,9 @@ Use the `aws_ebs_snapshots` InSpec audit resource to test properties of a collec For additional information, including details on parameters and properties, see the [AWS documentation on EBS Snapshots](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSsnapshots.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -72,7 +72,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -94,6 +96,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client::DescribeSnapshotsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client::DescribeSnapshotsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_volume.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_volume.md index 7b911058c8..7a6a931744 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_volume.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_volume.md @@ -14,9 +14,9 @@ Use the `aws_ebs_volume` InSpec audit resource to test the properties of a singl For additional information, including details on parameters and properties, see the [AWS documentation on EBS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -102,7 +102,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -132,6 +134,6 @@ it { should be_encrypted } ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVolumesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVolumesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_volumes.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_volumes.md index 237e394a70..86c1b73e2b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_volumes.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ebs_volumes.md @@ -16,9 +16,9 @@ EBS volumes are persistent block storage volumes for Amazon EC2 instances in the For additional information, including details on parameters and properties, see the [AWS documentation on EBS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -110,7 +110,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -132,5 +134,5 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVolumesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVolumesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_capacity_reservation.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_capacity_reservation.md index 2b9e233b39..41432061d5 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_capacity_reservation.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_capacity_reservation.md @@ -16,9 +16,9 @@ The `AWS::EC2::CapacityReservation` resource type creates a new Capacity Reserva For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Capacity Reservation.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -118,7 +118,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -152,4 +152,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeCapacityReservationsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeCapacityReservationsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_capacity_reservations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_capacity_reservations.md index a7bc054b68..f66e5244c0 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_capacity_reservations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_capacity_reservations.md @@ -16,9 +16,9 @@ The `AWS::EC2::CapacityReservation` resource type creates a new Capacity Reserva For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Capacity Reservation.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -156,7 +156,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -180,4 +180,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeCapacityReservationsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeCapacityReservationsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_carrier_gateway.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_carrier_gateway.md index 1695c5221e..7e438135dd 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_carrier_gateway.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_carrier_gateway.md @@ -20,9 +20,9 @@ The AWS::EC2::CarrierGateway resource creates a carrier gateway. For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Carrier Gateway](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -77,7 +77,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -111,4 +111,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeCarrierGatewaysResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeCarrierGatewaysResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_carrier_gateways.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_carrier_gateways.md index 7b36f5ee23..7cea57d38a 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_carrier_gateways.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_carrier_gateways.md @@ -16,9 +16,9 @@ The AWS::EC2::CarrierGateway resource creates a carrier gateway. For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Carrier Gateway](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-carriergateway.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -81,7 +81,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -105,4 +105,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeCarrierGatewaysResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeCarrierGatewaysResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_authorization_rule.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_authorization_rule.md index f14c617d40..2634d8eecf 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_authorization_rule.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_authorization_rule.md @@ -16,9 +16,9 @@ The `AWS::EC2::ClientVpnAuthorizationRule` specifies an ingress authorization ru For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Client VPN authorization rule.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -83,7 +83,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -117,4 +117,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeClientVpnAuthorizationRulesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeClientVpnAuthorizationRulesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_authorization_rules.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_authorization_rules.md index c6a02d0e20..807f2d9076 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_authorization_rules.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_authorization_rules.md @@ -16,9 +16,9 @@ The AWS::EC2::ClientVpnAuthorizationRule specifies an ingress authorization rule For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Client VPN authorization rule.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -93,7 +93,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -127,4 +127,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeClientVpnAuthorizationRulesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeClientVpnAuthorizationRulesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_endpoint.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_endpoint.md index 0fac4dc0b3..6082c7f89f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_endpoint.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_endpoint.md @@ -16,9 +16,9 @@ The `AWS::EC2::ClientVpnEndpoint` specifies a Client VPN endpoint. For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 ClientVpnEndpoint.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -160,7 +160,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -194,4 +194,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeClientVpnEndpointsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeClientVpnEndpointsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_endpoints.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_endpoints.md index b4fb8f6e58..e12aaa4933 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_endpoints.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_endpoints.md @@ -16,9 +16,9 @@ The `AWS::EC2::ClientVpnEndpoint` specifies a Client VPN endpoint. For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 ClientVpnEndpoint.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -226,7 +226,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -260,4 +260,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeClientVpnEndpointsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeClientVpnEndpointsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_route.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_route.md index f3efbc2538..173148c412 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_route.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_route.md @@ -16,9 +16,9 @@ The `AWS::EC2::ClientVpnRoute` specifies a network route to add to a Client VPN For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 ClientVpnRoute.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -102,7 +102,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -136,4 +136,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeClientVpnRoutesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeClientVpnRoutesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_routes.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_routes.md index 1a7f44b9df..48abe7dd6f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_routes.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_routes.md @@ -16,9 +16,9 @@ The `AWS::EC2::ClientVpnRoute` specifies a network route to add to a Client VPN For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 ClientVpnRoute.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -98,7 +98,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -132,4 +132,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeClientVpnRoutesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeClientVpnRoutesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_target_network_association.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_target_network_association.md index bba2e6d0ea..df2f2f3515 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_target_network_association.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_target_network_association.md @@ -16,9 +16,9 @@ The `AWS::EC2::ClientVpnTargetNetworkAssociation` checks if a target network to For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Client VPN target network association.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -83,7 +83,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -117,4 +117,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeClientVpnTargetNetworksResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeClientVpnTargetNetworksResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_target_network_associations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_target_network_associations.md index d800fed945..fb6822a6bf 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_target_network_associations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_client_vpn_target_network_associations.md @@ -16,9 +16,9 @@ The `AWS::EC2::ClientVpnTargetNetworkAssociation` specifies a target network to For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 ClientVpnTargetNetworkAssociation.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpntargetnetworkassociation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -93,7 +93,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -127,4 +127,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeClientVpnTargetNetworksResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeClientVpnTargetNetworksResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_customer_gateway.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_customer_gateway.md index b628918e52..712473cba2 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_customer_gateway.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_customer_gateway.md @@ -16,9 +16,9 @@ The `AWS::EC2::CustomerGateway` resource type specifies a customer gateway. For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 customer gateway](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -82,7 +82,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -116,4 +116,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeCustomerGatewaysResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeCustomerGatewaysResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_customer_gateways.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_customer_gateways.md index f579b3d8fc..19ba77b842 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_customer_gateways.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_customer_gateways.md @@ -16,9 +16,9 @@ The `AWS::EC2::CustomerGateway` resource type specifies a customer gateway. For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 customer gateway](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -96,7 +96,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -130,4 +130,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeCustomerGatewaysResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeCustomerGatewaysResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_dhcp_option.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_dhcp_option.md index b968381622..f65861b632 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_dhcp_option.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_dhcp_option.md @@ -14,9 +14,9 @@ Use the `aws_ec2_dhcp_option` InSpec audit resource to test the properties of a For additional information, including details on parameters and properties, see the [AWS documentation on EC2](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeDhcpOptions.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -87,6 +87,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeDhcpOptionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeDhcpOptionsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_dhcp_options.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_dhcp_options.md index a8d3858fba..c15b7b231a 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_dhcp_options.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_dhcp_options.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ec2_dhcp_options` InSpec audit resource to test properties of multiple AWS DHCP options sets. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -59,6 +59,6 @@ This resource does not have any examples. ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeDhcpOptionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeDhcpOptionsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_egress_only_internet_gateway.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_egress_only_internet_gateway.md index 212c525bd4..af9e600ed8 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_egress_only_internet_gateway.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_egress_only_internet_gateway.md @@ -14,9 +14,9 @@ Use the `aws_ec2_egress_only_internet_gateway` InSpec audit resource to test pro The `AWS::EC2::EgressOnlyInternetGateway` specifies an egress-only internet gateway for your VPC. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -73,7 +73,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -107,4 +107,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeEgressOnlyInternetGatewaysResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeEgressOnlyInternetGatewaysResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_egress_only_internet_gateways.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_egress_only_internet_gateways.md index 29586d54a1..d17bae1f1b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_egress_only_internet_gateways.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_egress_only_internet_gateways.md @@ -14,9 +14,9 @@ Use the `aws_ec2_egress_only_internet_gateways` InSpec audit resource to test pr The `AWS::EC2::EgressOnlyInternetGateway` specifies an egress-only internet gateway for your VPC. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -79,7 +79,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -113,4 +113,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeEgressOnlyInternetGatewaysResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeEgressOnlyInternetGatewaysResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eip.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eip.md index 352346233c..2ceec434e0 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eip.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eip.md @@ -16,9 +16,9 @@ An Elastic IP (EIP) is uniquely identified by the public IPv4 address, for examp For additional information, including details on parameters and properties, see the [AWS documentation on Elastic IP (EIP)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,7 +86,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -128,6 +128,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeAddressesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeAddressesResult" %}} See the [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html) documentation for additional information. diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eip_association.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eip_association.md index 8268d31e16..c9ff7dc49c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eip_association.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eip_association.md @@ -20,9 +20,9 @@ The association ID for the address. For additional information, including details on parameters and properties, see the [AWS documentation on AWS Elastic IP association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -57,7 +57,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -91,6 +91,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeAddressesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeAddressesResult" %}} See the [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html) documentation for additional information. diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eip_associations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eip_associations.md index f0574d1a9d..c52c65ce03 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eip_associations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eip_associations.md @@ -16,9 +16,9 @@ This resource does not expect any parameters. For additional information, including details on parameters and properties, see the [AWS documentation on AWS Elastic IP association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -53,7 +53,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -77,6 +79,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeAddressesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeAddressesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eips.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eips.md index 4d01eeb8c9..79d5809ec5 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eips.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_eips.md @@ -16,9 +16,9 @@ This resource does not expect any parameters. For additional information, including details on parameters and properties, see the [AWS documentation on Elastic IP (EIP)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -96,7 +96,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -112,6 +114,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeAddressesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeAddressesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_fleet.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_fleet.md index 29ad63070c..51bb88ad28 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_fleet.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_fleet.md @@ -16,9 +16,9 @@ The `AWS::EC2::SpotFleet` resource specifies the configuration information to la For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Fleet.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -166,7 +166,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -200,4 +200,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeFleetsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeFleetsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_fleets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_fleets.md index a03b03fc9c..f024a04815 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_fleets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_fleets.md @@ -16,9 +16,9 @@ The `AWS::EC2::SpotFleet` resource specifies the configuration information to la For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Fleet.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -156,7 +156,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -190,4 +190,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeFleetsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeFleetsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_host.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_host.md index e6075673b5..b804745df8 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_host.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_host.md @@ -16,9 +16,9 @@ The `AWS::EC2::host` allocates a fully dedicated physical server for launching E For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 host.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -124,7 +124,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -158,4 +158,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeHostsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeHostsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_hosts.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_hosts.md index 2b0f41625e..fc87b6c58c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_hosts.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_hosts.md @@ -16,9 +16,9 @@ The `AWS::EC2::host` allocates a fully dedicated physical server for launching E For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 host.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -141,7 +141,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -175,4 +175,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeHostsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeHostsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_instance.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_instance.md index 30fa9f3164..38992cfa5e 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_instance.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_instance.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ec2_instance` InSpec audit resource to test properties of a single AWS EC2 instance. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -126,8 +126,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} +This resource has the following special matchers. ### exist @@ -214,6 +215,6 @@ it { should be_unknown } ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeInstancesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeInstancesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_instances.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_instances.md index 685053160a..5ed5b31b70 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_instances.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_instances.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ec2_instances` InSpec audit resource to test properties of some or all AWS EC2 instances. To audit a single EC2 instance, use `aws_ec2_instance` (singular). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -137,7 +137,7 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### exist @@ -160,6 +160,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeInstancesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeInstancesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_internet_gateway.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_internet_gateway.md index 3c1450dd14..7c37e8bd13 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_internet_gateway.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_internet_gateway.md @@ -16,9 +16,9 @@ The `AWS::EC2::InternetGateway` resource allocates an internet gateway for use w For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 internet gateway](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -92,7 +92,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -126,4 +126,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeInternetGatewaysResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeInternetGatewaysResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_internet_gateways.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_internet_gateways.md index 5805485c4a..be6f1321cc 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_internet_gateways.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_internet_gateways.md @@ -16,9 +16,9 @@ The `AWS::EC2::InternetGateway` resource allocates an internet gateway for use w For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 internet gateway](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -102,7 +102,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -126,4 +126,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeInternetGatewaysResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeInternetGatewaysResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_launch_template.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_launch_template.md index d2ab6d91bb..56aeed821c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_launch_template.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_launch_template.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ec2_launch_template` InSpec audit resource to test properties of a single AWS Launch Template. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_launch_templates.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_launch_templates.md index 5d51b365fd..697704d347 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_launch_templates.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_launch_templates.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ec2_launch_templates` InSpec audit resource to test properties of a all the AWS Launch templates. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -79,4 +79,4 @@ There are also additional properties available. For a comprehensive list, see [t ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_analysis.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_analysis.md index 1009c4d2df..4110ecb1ff 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_analysis.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_analysis.md @@ -16,9 +16,9 @@ The `AWS::EC2::NetworkInsightsAnalysis` resource specifies a network insights an For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Network Insights Analysis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -97,7 +97,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -131,4 +131,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeNetworkInsightsAnalysesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeNetworkInsightsAnalysesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_analysis_plural.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_analysis_plural.md index e10171ad78..40c8eddb90 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_analysis_plural.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_analysis_plural.md @@ -16,9 +16,9 @@ The `AWS::EC2::NetworkInsightsAnalysis` resource specifies a network insights an For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Network Insights Analysis](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -121,7 +121,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -145,4 +145,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeNetworkInsightsAnalysesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeNetworkInsightsAnalysesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_path.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_path.md index 3614efac67..e3c2435a04 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_path.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_path.md @@ -16,9 +16,9 @@ The `AWS::EC2::NetworkInsightsPath` resource specifies a path to analyze for rea For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 network insights path](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -88,7 +88,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -122,4 +122,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeNetworkInsightsPathsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeNetworkInsightsPathsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_paths.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_paths.md index f8440dd4cd..ece8b2f885 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_paths.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_insights_paths.md @@ -16,9 +16,9 @@ The `AWS::EC2::NetworkInsightsPath` resource specifies a path to analyze for rea For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 network insights path](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -106,7 +106,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -130,4 +130,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeNetworkInsightsPathsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeNetworkInsightsPathsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface.md index 558d80c0ae..a5c7c12c00 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface.md @@ -16,9 +16,9 @@ The `AWS::EC2::NetworkInterface` resource describes a network interface in an El For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 network interface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -163,7 +163,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -197,4 +197,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeNetworkInterfacesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeNetworkInterfacesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_attachment.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_attachment.md index 2280d417ef..090dfdd4f1 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_attachment.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_attachment.md @@ -16,9 +16,9 @@ The `AWS::EC2::NetworkInterfaceAttachment` resource attaches an elastic network For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 network interface attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -82,7 +82,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -116,4 +116,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeNetworkInterfacesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeNetworkInterfacesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_attachments.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_attachments.md index 009e66ffa6..04cde16a9a 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_attachments.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_attachments.md @@ -16,9 +16,9 @@ The `AWS::EC2::NetworkInterfaceAttachment` resource attaches an elastic network For additional information, including details on parameters and properties, see the [AWS documentation on AWS Lambda Function](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -96,7 +96,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -120,4 +120,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeNetworkInterfacesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeNetworkInterfacesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_permission.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_permission.md index 46bd5f00a3..8057b0b2ed 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_permission.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_permission.md @@ -14,9 +14,9 @@ Use the `aws_ec2_network_interface_permission` InSpec audit resource to test the For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Network Interface Permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -71,7 +71,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -105,4 +105,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeNetworkInterfacePermissionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeNetworkInterfacePermissionsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_permissions.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_permissions.md index 2b09628341..e53b8a0494 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_permissions.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interface_permissions.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ec2_network_interface_permissions` InSpec audit resource to test properties of multiple AWS EC2 network interface permission. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -79,7 +79,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -113,4 +113,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeNetworkInterfacePermissionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeNetworkInterfacePermissionsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interfaces.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interfaces.md index cde4298d3a..c9cb0e14f0 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interfaces.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_network_interfaces.md @@ -16,9 +16,9 @@ The `AWS::EC2::NetworkInterface` resource describes a network interface in an El For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 network interface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -161,7 +161,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -185,4 +185,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeNetworkInterfacesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeNetworkInterfacesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_placement_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_placement_group.md index f4d95ba546..85b2c1d2b7 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_placement_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_placement_group.md @@ -16,9 +16,9 @@ The `AWS::EC2::PlacementGroup` resource type specifies a placement group in whic For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 placement group.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,7 +76,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribePlacementGroupsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribePlacementGroupsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_placement_groups.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_placement_groups.md index 574e307a34..e21a0df8bd 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_placement_groups.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_placement_groups.md @@ -16,9 +16,9 @@ The `AWS::EC2::PlacementGroup` resource type specifies a placement group in whic For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 placement group.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,7 +86,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -120,4 +120,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribePlacementGroupsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribePlacementGroupsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_prefix_list.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_prefix_list.md index 99fcc32564..5be72e377e 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_prefix_list.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_prefix_list.md @@ -16,9 +16,9 @@ The `AWS::EC2::PrefixList` resource specifies a managed prefix list. For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 prefix lists](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -96,7 +96,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -130,4 +130,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeManagedPrefixListsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeManagedPrefixListsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_prefix_lists.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_prefix_lists.md index ff90234ef5..781db7442c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_prefix_lists.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_prefix_lists.md @@ -16,9 +16,9 @@ The `AWS::EC2::PrefixList` resource specifies a managed prefix list. For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 prefix lists](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-prefixlist.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -94,7 +94,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -118,4 +118,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeManagedPrefixListsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeManagedPrefixListsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_spot_fleet.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_spot_fleet.md index 16faf11eef..865fe92c1d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_spot_fleet.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_spot_fleet.md @@ -16,9 +16,9 @@ The `AWS::EC2::SpotFleet` resource specifies a Spot Fleet request. A Spot Fleet For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Spot Fleet.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -213,7 +213,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -247,4 +247,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeSpotFleetRequestsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeSpotFleetRequestsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_spot_fleets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_spot_fleets.md index fdaad16ac3..7d2aeec81b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_spot_fleets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_spot_fleets.md @@ -16,9 +16,9 @@ The `AWS::EC2::SpotFleet` resource specifies a Spot Fleet request. A Spot Fleet For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Spot Fleet.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,7 +86,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeSpotFleetRequestsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeSpotFleetRequestsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_filter.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_filter.md index ff757b2c08..55d5c62ba0 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_filter.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_filter.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ec2_traffic_mirror_filter` InSpec audit resource to test properties of a single AWS traffic mirror filter. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -72,7 +72,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -106,6 +106,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeTrafficMirrorFiltersResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeTrafficMirrorFiltersResult" %}} See the [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html) documentation for additional information. diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_filters.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_filters.md index a89104696e..e5c5c7069c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_filters.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_filters.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ec2_traffic_mirror_filters` InSpec audit resource to test properties of multiple AWS traffic mirror filters. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -71,7 +71,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -95,6 +95,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeTrafficMirrorFiltersResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeTrafficMirrorFiltersResult" %}} See the [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html) documentation for additional information. diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_session.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_session.md index 60eff9506e..21026add89 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_session.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_session.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ec2_traffic_mirror_session` InSpec audit resource to test properties an AWS Traffic Mirror session. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -94,7 +94,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### be_available @@ -117,4 +119,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeTrafficMirrorSessionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeTrafficMirrorSessionsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_sessions.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_sessions.md index d0c451716f..74c9d7a784 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_sessions.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_traffic_mirror_sessions.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ec2_traffic_mirror_sessions` InSpec audit resource to test properties of all AWS Traffic Mirror sessions. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -106,7 +106,9 @@ For additional information, see [the API reference documentation](https://docs.a ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### be_available @@ -124,4 +126,4 @@ Use `should_not` to test a Traffic mirror session that should not exist. ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeTrafficMirrorSessionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeTrafficMirrorSessionsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_attachment.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_attachment.md index f671d914da..051bdd7937 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_attachment.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_attachment.md @@ -16,9 +16,9 @@ A Transit Gateway attachment attaches a VPC to a Transit Gateway. For additional information, including details on parameters and properties, see the [AWS documentation on Transit Gateway attachments](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -97,7 +97,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -139,6 +139,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ec2:DescribeAddresses" %}} +{{% inspec-aws/aws_permissions_principal action="ec2:DescribeAddresses" %}} See the [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html) documentation for additional information. diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_attachments.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_attachments.md index a881869c04..5e8ac2450b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_attachments.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_attachments.md @@ -16,9 +16,9 @@ This resource does not expect any parameters. For additional information, including details on parameters and properties, see the [AWS documentation on Transit Gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayattachment.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -99,7 +99,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -124,6 +126,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ec2:DescribeVpcEndpoints" %}} +{{% inspec-aws/aws_permissions_principal action="ec2:DescribeVpcEndpoints" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table.md index acb887aa24..df1fe4917d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table.md @@ -16,9 +16,9 @@ A Transit Gateway route table association associates the specified attachment wi For additional information, including details on parameters and properties, see the [AWS documentation on Transit Gateway route table](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -79,7 +79,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -121,6 +121,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ec2:describe_transit_gateway_route_tables" %}} +{{% inspec-aws/aws_permissions_principal action="ec2:describe_transit_gateway_route_tables" %}} See the [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html) documentation for additional information. diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_association.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_association.md index ca18171cc7..c2d389ab5c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_association.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_association.md @@ -14,9 +14,9 @@ Use the `aws_ec2_transit_gateway_route_table_association` InSpec audit resource A transit gateway route table association associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -102,6 +102,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ec2:client:get_transit_gateway_route_table_associations" %}} +{{% inspec-aws/aws_permissions_principal action="ec2:client:get_transit_gateway_route_table_associations" %}} For addition information, check out the [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html) documentation. diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_associations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_associations.md index 5b884b8b26..9939f3a27c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_associations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_associations.md @@ -14,9 +14,9 @@ Use the `aws_ec2_transit_gateway_route_table_associations` InSpec audit resource An AWS transit gateway route table association associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -100,6 +100,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:GetTransitGatewayRouteTableAssociationsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:GetTransitGatewayRouteTableAssociationsResult" %}} For addition information, check out the [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html) documentation. diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_propagation.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_propagation.md index a967ae2549..86d0b8ac97 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_propagation.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_propagation.md @@ -16,9 +16,9 @@ The `AWS::EC2::TransitGatewayRouteTablePropagation` resource enables the specifi For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 TransitGatewayRouteTablePropagation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -74,9 +74,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -108,4 +108,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:GetTransitGatewayRouteTablePropagationsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:GetTransitGatewayRouteTablePropagationsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_propagations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_propagations.md index 3f3506a04d..e8bfbaebd2 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_propagations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_table_propagations.md @@ -16,9 +16,9 @@ The `AWS::EC2::TransitGatewayRouteTablePropagation` resource enables the specifi For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 TransitGatewayRouteTablePropagation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetablepropagation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -78,9 +78,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -112,4 +112,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:GetTransitGatewayRouteTablePropagationsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:GetTransitGatewayRouteTablePropagationsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_tables.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_tables.md index 8d6a0929ae..566d7a53a4 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_tables.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_transit_gateway_route_tables.md @@ -16,9 +16,9 @@ This resource does not expect any parameters. For additional information, including details on parameters and properties, see the [AWS documentation on Transit Gateway route tables](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroutetable.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -87,7 +87,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -109,6 +111,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeTransitGatewayRouteTablesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeTransitGatewayRouteTablesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_volume_attachment.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_volume_attachment.md index 6cf2ed852c..2ddd9a77ca 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_volume_attachment.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_volume_attachment.md @@ -16,9 +16,9 @@ The `AWS::EC2::VolumeAttachment` resource attaches an Amazon EBS volume to a run For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Volume Attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,7 +76,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVolumesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVolumesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_volume_attachments.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_volume_attachments.md index e6c60cb8e1..38922685f8 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_volume_attachments.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_volume_attachments.md @@ -16,9 +16,9 @@ The `AWS::EC2::VolumeAttachment` resource attaches an Amazon EBS volume to a run For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 Volume Attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,7 +86,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVolumesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVolumesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpc_peering_connection.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpc_peering_connection.md index ee72c8217c..1916d9fd33 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpc_peering_connection.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpc_peering_connection.md @@ -16,9 +16,9 @@ The AWS::EC2::VPCPeeringConnection resource requests a VPC peering connection be For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 VPC Peering Connection.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -193,7 +193,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -227,4 +227,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpcPeeringConnectionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpcPeeringConnectionsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpc_peering_connections.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpc_peering_connections.md index 5742ea9af1..d246e0257c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpc_peering_connections.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpc_peering_connections.md @@ -16,9 +16,9 @@ The AWS::EC2::VPCPeeringConnection resource requests a VPC peering connection be For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 VPC Peering Connection.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,7 +86,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpcPeeringConnectionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpcPeeringConnectionsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpn_connection_routes.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpn_connection_routes.md index 8617b148b8..fde726812e 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpn_connection_routes.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpn_connection_routes.md @@ -16,9 +16,9 @@ The `AWS::EC2::VPNConnectionRoute` resource specifies a static route for a VPN c For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 VPN Connection Route.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection-route.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -73,7 +73,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -97,4 +97,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpnConnectionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpnConnectionsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpn_gateway_route_propagation.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpn_gateway_route_propagation.md index 7d037834c7..8483b0a235 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpn_gateway_route_propagation.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpn_gateway_route_propagation.md @@ -16,9 +16,9 @@ The `AWS::EC2::TransitGatewayRouteTablePropagation` resource enables a virtual p For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 VPNGatewayRoutePropagation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gatewayrouteprop.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -64,7 +64,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -98,4 +98,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeRouteTablesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeRouteTablesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpn_gateway_route_propagations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpn_gateway_route_propagations.md index 484125b03a..3f469a92bf 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpn_gateway_route_propagations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ec2_vpn_gateway_route_propagations.md @@ -16,9 +16,9 @@ The `AWS::EC2::VPNGatewayRoutePropagation` resource enables a virtual private ga For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 VPNGatewayRoutePropagation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gatewayrouteprop.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -66,7 +66,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -100,4 +100,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeRouteTablesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeRouteTablesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr.md index dc6e680114..eee83404eb 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr.md @@ -19,9 +19,9 @@ parent = "inspec/resources/aws" Use the `aws_ecr` InSpec audit resource to test properties of a single AWS Elastic Container Registry. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -89,8 +89,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} +This resource has the following special matchers. ### exist diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_image.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_image.md index 1435f72b73..11ed419322 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_image.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_image.md @@ -13,9 +13,9 @@ parent = "inspec/resources/aws" Use the `aws_ecr_image` InSpec audit resource to test the properties of a single image in an AWS Elastic Container Registry (ECR) repository. This resource is available in InSpec AWS resource pack version **[1.11.0](https://github.com/inspec/inspec-aws/releases/tag/v1.11.0)** onwards. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -111,8 +111,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} +This resource has the following special matchers. ### exist diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_images.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_images.md index 09ab75db01..15b1581479 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_images.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_images.md @@ -13,9 +13,9 @@ parent = "inspec/resources/aws" Use the `aws_ecr_images` InSpec audit resource to test the properties of all images in an AWS Elastic Container Registry (ECR) repository. This resource is available in InSpec AWS resource pack version **[1.11.0](https://github.com/inspec/inspec-aws/releases/tag/v1.11.0)** onwards. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -95,8 +95,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} +This resource has the following special matchers. ### exist @@ -118,6 +119,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ECR:Client:DescribeImagesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ECR:Client:DescribeImagesResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon ECR](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Operations.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_repositories.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_repositories.md index cc406d8c4d..6acd29c1c2 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_repositories.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_repositories.md @@ -13,9 +13,9 @@ parent = "inspec/resources/aws" Use the `aws_ecr_repositories` InSpec audit resource to test the properties of all repositories in an AWS Elastic Container Registry (ECR). This resource is available in InSpec AWS resource pack version **[1.11.0](https://github.com/inspec/inspec-aws/releases/tag/v1.11.0)** onwards. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -85,7 +85,7 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### exist @@ -107,6 +107,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ECR:Client:DescribeRepositoriesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ECR:Client:DescribeRepositoriesResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon ECR](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Operations.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_repository.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_repository.md index 8acc197dcd..2f063da118 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_repository.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_repository.md @@ -13,9 +13,9 @@ parent = "inspec/resources/aws" Use the `aws_ecr_repository` InSpec audit resource to test the properties of a single AWS Elastic Container Registry (ECR) repository. This resource is available in InSpec AWS resource pack version **[1.11.0](https://github.com/inspec/inspec-aws/releases/tag/v1.11.0)** onwards. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -95,8 +95,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} +This resource has the following special matchers. ### exist @@ -108,6 +109,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ECR:Client:DescribeRepositoriesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ECR:Client:DescribeRepositoriesResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon ECR](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Operations.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_repository_policy.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_repository_policy.md index e7c622813a..1737dcd446 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_repository_policy.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecr_repository_policy.md @@ -14,9 +14,9 @@ Use the `aws_ecr_repository_policy` InSpec audit resource to test the policy con New in InSpec AWS resource pack [1.11.0](https://github.com/inspec/inspec-aws/releases/tag/v1.11.0). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -102,6 +102,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ECR:Client:GetRepositoryPolicyResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ECR:Client:GetRepositoryPolicyResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon ECR](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Operations.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecrpublic_repositories.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecrpublic_repositories.md index 9374f4a533..00a8c3eeae 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecrpublic_repositories.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecrpublic_repositories.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ecrpublic_repositories` InSpec audit resource to test the properties of all public repositories in an AWS Elastic Container Registry (ECR). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -68,7 +68,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -90,6 +92,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ECRPublic:Client:DescribeRepositoriesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ECRPublic:Client:DescribeRepositoriesResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon ECR Public](https://docs.aws.amazon.com/AmazonECRPublic/latest/APIReference/API_Repository.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecrpublic_repository.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecrpublic_repository.md index 6511df2089..34c21b651f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecrpublic_repository.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecrpublic_repository.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ecrpublic_repository` InSpec audit resource to test the properties of a single AWS Elastic Container Registry (ECR) public repository. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -74,10 +74,10 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ## AWS Permissions -{{% aws_permissions_principal action="ECRPublic:Client:DescribeRepositoriesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ECRPublic:Client:DescribeRepositoriesResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon ECR Public](https://docs.aws.amazon.com/AmazonECRPublic/latest/APIReference/API_Repository.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_cluster.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_cluster.md index 4ece42d02e..2317f0a876 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_cluster.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_cluster.md @@ -14,9 +14,9 @@ Use the `aws_ecs_cluster` InSpec audit resource to test properties of a single A For additional information, including details on parameters and properties, see the [AWS documentation on ECS Clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_clusters.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -84,7 +84,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -106,5 +108,5 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ECS:Client:DescribeClustersResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ECS:Client:DescribeClustersResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_clusters.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_clusters.md index 99c6c4de8d..fc887aa727 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_clusters.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_clusters.md @@ -14,9 +14,9 @@ Use the `aws_ecs_clusters` InSpec audit resource to test properties of some or a For additional information, including details on parameters and properties, see the [AWS documentation on ECS Clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_clusters.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,7 +76,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_service.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_service.md index 43dc772bbd..cd9b5826e6 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_service.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_service.md @@ -16,9 +16,9 @@ The AWS ECS Service resource creates an Amazon Elastic Container Service (Amazon For additional information, including details on parameters and properties, see the [AWS documentation on ECS Service](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -95,7 +95,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -129,4 +129,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ECS:Client:DeleteServiceResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ECS:Client:DeleteServiceResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_services.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_services.md index 0c8b71cf7f..5239ea91b0 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_services.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_services.md @@ -15,9 +15,9 @@ The AWS ECS Service resource creates an Amazon Elastic Container Service (Amazon For additional information, including details on parameters and properties, see the [AWS documentation on ECS Service](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -81,7 +81,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -115,4 +115,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ECS:Client:ListServicesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ECS:Client:ListServicesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_task_definition.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_task_definition.md index f5c14ae416..b2b4374ff5 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_task_definition.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_task_definition.md @@ -14,9 +14,9 @@ Use the `aws_ecs_task_definition` InSpec audit resource to test the properties o For additional information, including details on parameters and properties, see the [AWS ECS task definition documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -813,7 +813,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -847,4 +847,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ECS:Client:DescribeTaskDefinitionResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ECS:Client:DescribeTaskDefinitionResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_task_definitions.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_task_definitions.md index 6f0bf3ee8e..7e753b8889 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_task_definitions.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ecs_task_definitions.md @@ -14,9 +14,9 @@ Use the `aws_ecs_task_definitions` InSpec audit resource to test the properties For additional information, including details on parameters and properties, see the [AWS ECS task definition documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -49,7 +49,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list_task_definitions` method returns at least one result. @@ -83,4 +83,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ECS:Client:ListTaskDefinitionsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ECS:Client:ListTaskDefinitionsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_file_system.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_file_system.md index 7d563395ef..d370a41684 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_file_system.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_file_system.md @@ -13,9 +13,9 @@ parent = "inspec/resources/aws" Use the `aws_efs_file_system` InSpec audit resource to test the properties of a single AWS EFS file system. This resource is added to InSpec AWS resource pack in version **[1.10.0](https://github.com/inspec/inspec-aws/releases/tag/v1.10.0)** and it is available with InSpec **[4.18.108](https://github.com/inspec/inspec/releases/tag/v4.18.108)** and later versions. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -115,8 +115,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} +This resource has the following special matchers. ### exist @@ -136,6 +137,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EFS:Client:DescribeFileSystemsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="EFS:Client:DescribeFileSystemsResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EFS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonelasticfilesystem.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_file_systems.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_file_systems.md index a43b450b53..05851ed33b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_file_systems.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_file_systems.md @@ -14,9 +14,9 @@ Use the `aws_efs_file_systems` InSpec audit resource to test the properties of s This resource is added to InSpec AWS resource pack in version **[1.10.0](https://github.com/inspec/inspec-aws/releases/tag/v1.10.0)** and it is available with InSpec **[4.18.108](https://github.com/inspec/inspec/releases/tag/v4.18.108)** and later versions. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -98,7 +98,7 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### exist @@ -120,6 +120,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EFS:Client:DescribeFileSystemsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="EFS:Client:DescribeFileSystemsResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EFS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonelasticfilesystem.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_mount_target.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_mount_target.md index f2765ef731..0649e91106 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_mount_target.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_mount_target.md @@ -16,9 +16,9 @@ The AWS::EFS::MountTarget resource is an Amazon EFS resource that creates a moun For additional information, including details on parameters and properties, see the [AWS documentation on EFS Mount Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -83,7 +83,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -117,4 +117,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EFS:Client:DescribeMountTargetsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="EFS:Client:DescribeMountTargetsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_mount_targets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_mount_targets.md index 21f0d2593e..e41161cf5c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_mount_targets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_efs_mount_targets.md @@ -16,9 +16,9 @@ The AWS::EFS::MountTarget resource is an Amazon EFS resource that creates a moun For additional information, including details on parameters and properties, see the [AWS documentation on EFS Mount Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -83,7 +83,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -114,4 +114,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EFS:Client:DescribeMountTargetsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="EFS:Client:DescribeMountTargetsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eks_cluster.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eks_cluster.md index aa1def6712..5eaa6d67b4 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eks_cluster.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eks_cluster.md @@ -14,9 +14,9 @@ Use the `aws_eks_cluster` InSpec audit resource to test properties of a single A For additional information, including details on parameters and properties, see the [AWS documentation on EKS Clusters](https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -171,7 +171,9 @@ end ## Matchers -This InSpec audit resource has no special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -193,7 +195,7 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EKS:Client:DescribeClusterResponse" %}} +{{% inspec-aws/aws_permissions_principal action="EKS:Client:DescribeClusterResponse" %}} You can find detailed documentation at [Amazon EKS IAM Policies, Roles, and Permissions](https://docs.aws.amazon.com/eks/latest/userguide/IAM_policies.html) The documentation for EKS actions is at [Policy Structure](https://docs.aws.amazon.com/eks/latest/userguide/iam-policy-structure.html#UsingWithEKS_Actions) diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eks_clusters.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eks_clusters.md index 99884569d5..6049c9e32d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eks_clusters.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eks_clusters.md @@ -14,9 +14,9 @@ Use the `aws_eks_clusters` resource to test the configuration of a collection of For additional information, including details on parameters and properties, see the [AWS documentation on EKS Clusters](https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -114,7 +114,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -137,7 +139,7 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EKS:Client:DescribeClusterResponse" %}} +{{% inspec-aws/aws_permissions_principal action="EKS:Client:DescribeClusterResponse" %}} You can find detailed documentation at [Amazon EKS IAM Policies, Roles, and Permissions](https://docs.aws.amazon.com/eks/latest/userguide/IAM_policies.html) The documentation for EKS actions is at [Policy Structure](https://docs.aws.amazon.com/eks/latest/userguide/iam-policy-structure.html#UsingWithEKS_Actions) diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_cluster.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_cluster.md index 2efe6c2d43..6bb3e9338b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_cluster.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_cluster.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_elasticache_cluster` InSpec audit resource to test the properties of a single AWS ElastiCache cluster. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -101,8 +101,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} +This resource has the following special matchers. ### exist @@ -122,6 +123,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElastiCache:Client:CacheClusterMessage" %}} +{{% inspec-aws/aws_permissions_principal action="ElastiCache:Client:CacheClusterMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon ElastiCache](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonelasticache.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_cluster_node.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_cluster_node.md index a258ad3e62..3b946a19d8 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_cluster_node.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_cluster_node.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_elasticache_cluster_node` InSpec audit resource to test the properties of a single AWS ElastiCache cluster node. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -90,8 +90,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} +This resource has the following special matchers. ### exist @@ -103,6 +104,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElastiCache:Client:CacheClusterMessage" %}} +{{% inspec-aws/aws_permissions_principal action="ElastiCache:Client:CacheClusterMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon ElastiCache](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonelasticache.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_clusters.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_clusters.md index 51fd0344e5..6f5b0295cb 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_clusters.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_clusters.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_elasticache_clusters` InSpec audit resource to test the properties of all AWS ElastiCache clusters. To audit a single ElastiCache cluster, use `aws_elasticache_cluster` (singular). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -80,7 +80,7 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### exist @@ -102,6 +102,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElastiCache:Client:CacheClusterMessage" %}} +{{% inspec-aws/aws_permissions_principal action="ElastiCache:Client:CacheClusterMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon ElastiCache](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonelasticache.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_replication_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_replication_group.md index 1bbd6b767c..5150c039c2 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_replication_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_replication_group.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_elasticache_replication_group` InSpec audit resource to test the properties of a single Amazon ElastiCache replication group. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -77,7 +77,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -97,6 +99,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElastiCache:Client:ReplicationGroupMessage" %}} +{{% inspec-aws/aws_permissions_principal action="ElastiCache:Client:ReplicationGroupMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon ElastiCache](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonelasticache.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_replication_groups.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_replication_groups.md index 8c23522e07..fe6765c80e 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_replication_groups.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticache_replication_groups.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_elasticache_replication_groups` InSpec audit resource to test the properties of all Amazon ElastiCache replication groups. To audit a single ElastiCache replication group, use `aws_elasticache_replication_group` (singular). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -69,7 +69,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -91,6 +93,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElastiCache:Client:ReplicationGroupMessage" %}} +{{% inspec-aws/aws_permissions_principal action="ElastiCache:Client:ReplicationGroupMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon ElastiCache](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonelasticache.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener.md index 773334422d..0cb6324cba 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener.md @@ -14,9 +14,9 @@ Use the `aws_elasticloadbalancingv2_listener` InSpec audit resource to test prop For additional information, including details on parameters and properties, see the [AWS documentation on ElasticLoadBalancingV2 Listener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -202,7 +202,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -218,7 +220,7 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeListenersOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeListenersOutput" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Auto Scaling Groups](https://docs.aws.amazon.com/autoscaling/ec2/userguide/control-access-using-iam.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_certificate.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_certificate.md index f8f849405a..48b47418f9 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_certificate.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_certificate.md @@ -14,9 +14,9 @@ Use the `aws_elasticloadbalancingv2_listener_certificate` InSpec audit resource For additional information, including details on parameters and properties, see the [AWS documentation on ElasticLoadBalancingV2 Listener Certificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -70,7 +70,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -86,5 +88,5 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeListenerCertificatesOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeListenerCertificatesOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_certificates.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_certificates.md index 3583ceff2d..f4a60d26be 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_certificates.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_certificates.md @@ -14,9 +14,9 @@ Use the `aws_elasticloadbalancingv2_listener_certificates` InSpec audit resource For additional information, including details on parameters and properties, see the [AWS documentation on ElasticLoadBalancingV2 Listener Certificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -62,7 +62,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -86,4 +86,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeListenerCertificatesOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeListenerCertificatesOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_rule.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_rule.md index 6499c1cda8..cff62c2677 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_rule.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_rule.md @@ -14,9 +14,9 @@ Use the `aws_elasticloadbalancingv2_listener_rule` InSpec audit resource to test For additional information, including details on parameters and properties, see the [AWS documentation on ELBv2 Listener Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -203,7 +203,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -237,4 +237,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeRulesOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeRulesOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_rules.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_rules.md index 7ac203fe79..c1e3f84f49 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_rules.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listener_rules.md @@ -16,9 +16,9 @@ Each rule consists of a priority, one or more actions, and one or more condition For additional information, including details on parameters and properties, see the [AWS documentation on ELBv2 Listener Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -83,7 +83,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -117,4 +117,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeRulesOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeRulesOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listeners.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listeners.md index d4161dbc97..b114b0fae2 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listeners.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_listeners.md @@ -14,9 +14,9 @@ Use the `aws_elasticloadbalancingv2_listeners` InSpec audit resource to test the For additional information, including details on parameters and properties, see the [AWS documentation on ElasticLoadBalancingV2 Listener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -72,7 +72,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist @@ -88,6 +88,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeListenersOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeListenersOutput" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Auto Scaling Groups](https://docs.aws.amazon.com/autoscaling/ec2/userguide/control-access-using-iam.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_target_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_target_group.md index ce48483766..1f547c94ad 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_target_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_target_group.md @@ -14,9 +14,9 @@ Use the `aws_elasticloadbalancingv2_target_group` InSpec audit resource to test For additional information, including details on parameters and properties, see the [AWS documentation on ElasticLoadBalancingV2 TargetGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -109,7 +109,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -143,4 +143,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeTargetGroupsOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeTargetGroupsOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_target_groups.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_target_groups.md index 26ff30cb01..16127a879d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_target_groups.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticloadbalancingv2_target_groups.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_elasticloadbalancingv2_target_groups` InSpec audit resource to test properties of multiple Elastic Load Balancing V2 target groups. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -100,7 +100,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -134,4 +134,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeTargetGroupsOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancingV2:Client:DescribeTargetGroupsOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticsearchservice_domain.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticsearchservice_domain.md index 9d21a0757c..1594557e34 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticsearchservice_domain.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticsearchservice_domain.md @@ -16,9 +16,9 @@ The AWS::Elasticsearch::Domain resource creates an Amazon Elasticsearch Service For additional information, including details on parameters and properties, see the [AWS documentation on Elasticsearch Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -242,7 +242,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -276,4 +276,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElasticsearchService:Client:DescribeElasticsearchDomainResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ElasticsearchService:Client:DescribeElasticsearchDomainResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticsearchservice_domains.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticsearchservice_domains.md index 540368f293..6689b18f35 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticsearchservice_domains.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elasticsearchservice_domains.md @@ -16,9 +16,9 @@ The AWS::Elasticsearch::Domain resource creates an Amazon Elasticsearch Service For additional information, including details on parameters and properties, see the [AWS documentation on Elasticsearch Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -51,7 +51,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -85,4 +85,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElasticsearchService:Client:ListDomainNamesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="ElasticsearchService:Client:ListDomainNamesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elb.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elb.md index a5891de50e..a47fd718dc 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elb.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elb.md @@ -14,9 +14,9 @@ Use the `aws_elb` InSpec audit resource to test properties of a single AWS Elast For additional information, including details on parameters and properties, see the [AWS documentation on Elastic Load Balancing](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -153,7 +153,9 @@ end ## Matchers -This InSpec audit resource has no special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -175,6 +177,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeAccessPointsOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeAccessPointsOutput" %}} You can find detailed documentation at [Authentication and Access Control for Your Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/load-balancer-authentication-access-control.html) diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elbs.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elbs.md index 86cbf0d220..0d80a52c24 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elbs.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_elbs.md @@ -14,9 +14,9 @@ Use the `aws_elbs` InSpec audit resource to test the configuration of a collecti For additional information, including details on parameters and properties, see the [AWS documentation on Elastic Load Balancing](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -85,7 +85,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist @@ -107,6 +107,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeAccessPointsOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeAccessPointsOutput" %}} You can find detailed documentation at [Authentication and Access Control for Your Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/load-balancer-authentication-access-control.html) diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_cluster.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_cluster.md index a86b885390..f06f289a1c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_cluster.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_cluster.md @@ -14,9 +14,9 @@ Use the `aws_emr_cluster` InSpec audit resource to test properties of the singul For additional information, including details on parameters and properties, see the [AWS documentation on AWS EMR clusters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -135,7 +135,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -157,4 +159,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EMR:Client:DescribeClusterOutput" %}} +{{% inspec-aws/aws_permissions_principal action="EMR:Client:DescribeClusterOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_clusters.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_clusters.md index a3b75d654e..acee3adecf 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_clusters.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_clusters.md @@ -14,9 +14,9 @@ Use the `aws_emr_clusters` resource to test the configuration of a collection of For additional information, including details on parameters and properties, see the [AWS documentation on AWS EMR clusters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -161,7 +161,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://docs.chef.io/inspec/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://docs.chef.io/inspec/matchers/). ### exist diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_security_configuration.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_security_configuration.md index 82a638a1c7..450c1c6c5f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_security_configuration.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_security_configuration.md @@ -14,9 +14,9 @@ Use the `aws_emr_security_configuration` InSpec audit resource to test propertie For additional information, including details on parameters and properties, see the [AWS documentation on AWS EMR security configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-securityconfiguration.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -80,7 +80,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -102,4 +104,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EMR:Client:DescribeSecurityConfigurationOutput" %}} +{{% inspec-aws/aws_permissions_principal action="EMR:Client:DescribeSecurityConfigurationOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_security_configurations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_security_configurations.md index 85b7e6b3a4..d48e662187 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_security_configurations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_emr_security_configurations.md @@ -14,9 +14,9 @@ Use the `aws_emr_security_configurations` resource to test the properties of col For additional information, including details on parameters and properties, see the [AWS documentation on AWS EMR security configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-securityconfiguration.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -67,7 +67,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://docs.chef.io/inspec/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://docs.chef.io/inspec/matchers/). ### exist @@ -89,4 +89,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EMR:Client:DescribeSecurityConfigurationOutput" %}} +{{% inspec-aws/aws_permissions_principal action="EMR:Client:DescribeSecurityConfigurationOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eventbridge_rule.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eventbridge_rule.md index bcbfeca81e..e5f6180e13 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eventbridge_rule.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eventbridge_rule.md @@ -16,9 +16,9 @@ The AWS::Events::Rule resource creates a rule that matches incoming events and r For additional information, including details on parameters and properties, see the [AWS documentation on Events Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,7 +86,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -120,4 +120,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EventBridge:Client:DescribeRuleResponse" %}} +{{% inspec-aws/aws_permissions_principal action="EventBridge:Client:DescribeRuleResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eventbridge_rules.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eventbridge_rules.md index 04499f2c5d..fa4d288491 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eventbridge_rules.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_eventbridge_rules.md @@ -16,9 +16,9 @@ The AWS::Events::Rule resource creates a rule that matches incoming events and r For additional information, including details on parameters and properties, see the [AWS documentation on Events Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -83,7 +83,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -117,4 +117,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EventBridge:Client:ListRulesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="EventBridge:Client:ListRulesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_flow_log.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_flow_log.md index 876f24ef61..0828309e60 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_flow_log.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_flow_log.md @@ -14,9 +14,9 @@ Use the `aws_flow_log` InSpec audit resource to test properties of a single Flow For additional information, including details on parameters and properties, see the [AWS documentation on Flow Logs](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -93,7 +93,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist @@ -146,4 +146,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeFlowLogsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeFlowLogsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_crawler.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_crawler.md index 0fb636449d..d59036311c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_crawler.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_crawler.md @@ -16,9 +16,9 @@ The AWS::Glue::Crawler resource specifies an AWS Glue crawler. For additional information, including details on parameters and properties, see the [AWS documentation on Glue Crawler](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -115,9 +115,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -149,4 +149,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:GetCrawlerResponse" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:GetCrawlerResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_crawlers.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_crawlers.md index 72ed710658..29b31fa1dd 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_crawlers.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_crawlers.md @@ -16,9 +16,9 @@ The AWS::Glue::Crawler resource specifies an AWS Glue crawler. For additional information, including details on parameters and properties, see the [AWS documentation on Glue Crawler](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -113,9 +113,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -147,4 +147,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:GetCrawlersResponse" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:GetCrawlersResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_database.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_database.md index 2e56f0e953..50b96de4df 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_database.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_database.md @@ -16,9 +16,9 @@ The AWS::Glue::Database resource specifies a logical grouping of tables in AWS G For additional information, including details on parameters and properties, see the [AWS documentation on Glue Database](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -88,9 +88,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -122,4 +122,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:GetDatabaseResponse" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:GetDatabaseResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_databases.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_databases.md index ad16117300..b946899ff1 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_databases.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_glue_databases.md @@ -16,9 +16,9 @@ The AWS::Glue::Database resource specifies a logical grouping of tables in AWS G For additional information, including details on parameters and properties, see the [AWS documentation on Glue Database](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -72,9 +72,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -106,4 +106,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:GetDatabasesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:GetDatabasesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_guardduty_detector.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_guardduty_detector.md index 2997b602cf..8b983f9312 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_guardduty_detector.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_guardduty_detector.md @@ -20,9 +20,9 @@ For additional information, including details on parameters and properties, see Train AWS version 0.1.18 or newer is required for this resource. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -78,7 +78,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### be_enabled @@ -116,4 +118,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="GuardDuty:Client:GetDetectorResponse" %}} +{{% inspec-aws/aws_permissions_principal action="GuardDuty:Client:GetDetectorResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_guardduty_detectors.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_guardduty_detectors.md index 5eebc1270a..fd08aaeaef 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_guardduty_detectors.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_guardduty_detectors.md @@ -22,9 +22,9 @@ For additional information, including details on parameters and properties, see Train AWS version 0.1.18 or newer is required for this resource. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -68,7 +68,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -90,4 +92,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="GuardDuty:Client:GetDetectorResponse" %}} +{{% inspec-aws/aws_permissions_principal action="GuardDuty:Client:GetDetectorResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_hosted_zone.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_hosted_zone.md index 83ab358192..2df49c5422 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_hosted_zone.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_hosted_zone.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_hosted_zone` resource to test a specific hosted zone configuration. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -65,7 +65,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -104,6 +106,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Route53:Client:GetHostedZoneResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Route53:Client:GetHostedZoneResponse" %}} You can find detailed documentation at [Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/r53-api-permissions-ref.html) diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_hosted_zones.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_hosted_zones.md index 174bbfd668..04b1f4e9e0 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_hosted_zones.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_hosted_zones.md @@ -16,9 +16,9 @@ The `AWS::Route53::HostedZone` creates a new public or private hosted zone. For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::Route53::HostedZone` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -94,7 +94,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -118,4 +118,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Route53:Client:ListHostedZonesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Route53:Client:ListHostedZonesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_access_key.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_access_key.md index 8aa4244c33..97b0a142e7 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_access_key.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_access_key.md @@ -14,9 +14,9 @@ Use the `aws_iam_access_key` InSpec audit resource to test properties of a singl For additional information, including details on parameters and properties, see the [AWS documentation on IAM Access Keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -79,7 +79,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -105,6 +107,6 @@ it { should be_active } ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:GetAccessKeyLastUsedResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:GetAccessKeyLastUsedResponse" %}} You can find detailed documentation at [Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/r53-api-permissions-ref.html) \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_access_keys.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_access_keys.md index 4d1fce9cce..292628417d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_access_keys.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_access_keys.md @@ -14,9 +14,9 @@ Use the `aws_iam_access_keys` InSpec audit resource to test properties of some o For additional information, including details on parameters and properties, see the [AWS documentation on IAM Access Keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -106,7 +106,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_account_alias.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_account_alias.md index b472d1201c..72237b99ac 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_account_alias.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_account_alias.md @@ -14,9 +14,9 @@ Use the `aws_iam_account_alias` InSpec audit resource to test properties of the For additional information, including details on parameters and properties, see the [AWS documentation on Account Aliases](https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -72,5 +72,5 @@ end ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:ListAccountAliasesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:ListAccountAliasesResponse" %}} \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_group.md index bb426d0d03..b476e5bb2a 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_group.md @@ -14,9 +14,9 @@ Use the `aws_iam_group` InSpec audit resource to test properties of a single IAM For additional information, including details on parameters and properties, see the [AWS documentation on IAM Groups](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -91,6 +91,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:GetGroupResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:GetGroupResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_groups.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_groups.md index 2b0012dac8..7eb78e7bc6 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_groups.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_groups.md @@ -14,9 +14,9 @@ Use the `aws_iam_groups` InSpec audit resource to test properties of a collectio For additional information, including details on parameters and properties, see the [AWS documentation on IAM Groups](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -95,6 +95,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:ListGroupsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:ListGroupsResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_inline_policy.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_inline_policy.md index 0e09f34fb1..8e83ca9d8e 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_inline_policy.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_inline_policy.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_iam_inline_policy` InSpec audit resource to test properties of a single inline AWS IAM Policy embedded with IAM User, IAM Group or IAM Role. For managed policies, use the `aws_iam_policy` resource. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -94,7 +94,9 @@ it { should_not have_statement(NotAction: 'iam:*') } ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_instance_profile.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_instance_profile.md index 263000dded..6def1c4f16 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_instance_profile.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_instance_profile.md @@ -16,9 +16,9 @@ This resource retrieves information about the specified instance profile, includ For additional information, including details on parameters and properties, see the [AWS documentation on IAM Instance Profile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -113,9 +113,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -147,4 +147,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:GetInstanceProfileResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:GetInstanceProfileResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_instance_profiles.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_instance_profiles.md index 1d31b48936..e306996c69 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_instance_profiles.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_instance_profiles.md @@ -16,9 +16,9 @@ This resource lists the instance profiles that have the specified path prefix. For additional information, including details on parameters and properties, see the [AWS documentation on IAM Instance Profile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -74,7 +74,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -108,4 +108,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:ListInstanceProfilesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:ListInstanceProfilesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_managed_policies.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_managed_policies.md index 5bd95237dc..36ef179b71 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_managed_policies.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_managed_policies.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_iam_managed_policies` InSpec audit resource to test the properties of a collection of AWS IAM managed policies. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -118,7 +118,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist @@ -142,6 +142,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="iam:ListPolicies" %}} +{{% inspec-aws/aws_permissions_principal action="iam:ListPolicies" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_managed_policy.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_managed_policy.md index ca6bf91b3e..1f2f0f054c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_managed_policy.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_managed_policy.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_iam_managed_policy` InSpec audit resource to test the properties of an AWS IAM managed policy. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -75,7 +75,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist @@ -99,6 +99,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="iam:ListPolicies" %}} +{{% inspec-aws/aws_permissions_principal action="iam:ListPolicies" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_oidc_provider.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_oidc_provider.md index ea9c474cfe..b03b0605e9 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_oidc_provider.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_oidc_provider.md @@ -16,9 +16,9 @@ This resource retrieves information about the specified OIDC provider. For additional information, including details on parameters and properties, see the [AWS documentation on IAM OIDC provider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-oidcprovider.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -67,9 +67,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -101,4 +101,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:GetOpenIDConnectProviderResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:GetOpenIDConnectProviderResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_oidc_providers.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_oidc_providers.md index 504284d559..f7d0f186a2 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_oidc_providers.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_oidc_providers.md @@ -14,9 +14,9 @@ Use the `aws_iam_oidc_providers` InSpec audit resource to test properties of a s This resource retrieves information about all OIDC providers. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -51,7 +51,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -85,4 +85,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:ListOpenIDConnectProviderTagsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:ListOpenIDConnectProviderTagsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_password_policy.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_password_policy.md index 1409051376..78477f5b9e 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_password_policy.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_password_policy.md @@ -14,9 +14,9 @@ Use the `aws_iam_password_policy` InSpec audit resource to test properties of an For additional information, including details on parameters and properties, see the [AWS documentation on Auto Scaling Group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -66,7 +66,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_policies.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_policies.md index cb2b5b81ae..c46bf8b2cc 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_policies.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_policies.md @@ -14,9 +14,9 @@ Use the `aws_iam_policies` InSpec audit resource to test properties of a collect For additional information, including details on parameters and properties, see the [AWS documentation on IAM Policy](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -90,7 +90,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist @@ -112,6 +112,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:ListPoliciesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:ListPoliciesResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_policy.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_policy.md index af29ece5a7..83ecd708a3 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_policy.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_policy.md @@ -14,9 +14,9 @@ Use the `aws_iam_policy` InSpec audit resource to test properties of a single ma For additional information, including details on parameters and properties, see the [AWS documentation on IAM Policy](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -119,7 +119,9 @@ it { should_not have_statement(NotAction: 'iam:*') } ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_role.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_role.md index aae5a48c95..f873ff7800 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_role.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_role.md @@ -14,9 +14,9 @@ Use the `aws_iam_role` InSpec audit resource to test properties of an AWS IAM Ro For additional information, including details on parameters and properties, see the [AWS documentation on IAM Roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -89,8 +89,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} +This resource has the following special matchers. ### exist @@ -112,7 +113,7 @@ end ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:GetRoleResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:GetRoleResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_roles.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_roles.md index 30a544ec03..91389389ee 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_roles.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_roles.md @@ -14,9 +14,9 @@ Use the `aws_iam_roles` InSpec audit resource to test properties of a collection For additional information, including details on parameters and properties, see the [AWS documentation on IAM Roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -87,7 +87,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist @@ -103,6 +103,6 @@ You may also use `it { should_not exist }`. ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:ListRolesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:ListRolesResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_root_user.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_root_user.md index 5e5d773215..635585cc80 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_root_user.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_root_user.md @@ -14,9 +14,9 @@ Use the `aws_iam_root_user` InSpec audit resource to test properties of an AWS I For additional information, including details on parameters and properties, see the [AWS documentation on Root Users](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -69,7 +69,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_saml_provider.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_saml_provider.md index f59868c782..9cd748e9b9 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_saml_provider.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_saml_provider.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_iam_saml_provider` InSpec audit resource to test properties of an AWS IAM SAML Provider. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -72,7 +72,7 @@ describe aws_iam_saml_provider("arn:aws:iam::123456789012:saml-provider/FANCY") ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist @@ -87,4 +87,4 @@ You may also use `it { should_not exist }`. ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:GetSAMLProviderResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:GetSAMLProviderResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_saml_providers.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_saml_providers.md index a9e980ea77..56aec31edf 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_saml_providers.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_saml_providers.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_iam_saml_providers` InSpec audit resource to test properties of some or all AWS IAM SAML Providers. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -79,7 +79,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_server_certificate.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_server_certificate.md index 231f351d57..3e180a5fbe 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_server_certificate.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_server_certificate.md @@ -16,9 +16,9 @@ This resource retrieves information about the specified server certificate, incl For additional information, including details on parameters and properties, see the [AWS documentation on IAM Instance Profile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -74,9 +74,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -108,4 +108,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:GetServerCertificateResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:GetServerCertificateResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_server_certificates.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_server_certificates.md index 12b0c528ca..cc677fb20e 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_server_certificates.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_server_certificates.md @@ -14,9 +14,9 @@ Use the `aws_iam_server_certificates` InSpec audit resource to test the properti This resource retrieves information about the server certificate, including the server certificate's path, GUID, ARN, and role. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -70,7 +70,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -104,4 +104,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:ListServerCertificateResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:ListServerCertificateResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_service_linked_role_deletion_status.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_service_linked_role_deletion_status.md index a981f3928f..6e2ceba5ad 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_service_linked_role_deletion_status.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_service_linked_role_deletion_status.md @@ -18,9 +18,9 @@ The deletion task identifier. For additional information, including details on parameters and properties, see the [AWS documentation on Service linked role deletion status](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servicelinkedrole.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -57,7 +57,7 @@ end This InSpec audit resource has the following special matchers. For a complete list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). -The controls will pass if the `get` method returns at least one result. + ### exist @@ -89,4 +89,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:GetServiceLinkedRoleDeletionStatusResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:GetServiceLinkedRoleDeletionStatusResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_ssh_public_key.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_ssh_public_key.md index ff9ef89111..650bdc4d4b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_ssh_public_key.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_ssh_public_key.md @@ -14,9 +14,9 @@ Use the `aws_iam_ssh_public_key` InSpec audit resource to test the properties of For additional information, including details on parameters and properties, see the [AWS documentation on AWS IAM AccessKey.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -93,7 +93,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The control passes if the `get` method returns at least one result. @@ -127,4 +127,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:GetSSHPublicKeyResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:GetSSHPublicKeyResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_ssh_public_keys.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_ssh_public_keys.md index 34fe1696cd..87d377f0b9 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_ssh_public_keys.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_ssh_public_keys.md @@ -14,9 +14,9 @@ Use the `aws_iam_ssh_public_keys` InSpec audit resource to test the properties o For additional information, including details on parameters and properties, see the [AWS documentation on AWS IAM AccessKey.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -100,7 +100,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The control passes if the `list` method returns at least one result. @@ -152,4 +152,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:ListSSHPublicKeysResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:ListSSHPublicKeysResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_user.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_user.md index ac73ac541f..f36ab78a29 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_user.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_user.md @@ -14,9 +14,9 @@ Use the `aws_iam_user` InSpec audit resource to test properties of a single AWS For additional information, including details on parameters and properties, see the [AWS documentation on IAM Users](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -32,19 +32,19 @@ end `user_name` _(required)_ -: This resource accepts a single parameter, the User's username which uniquely identifies the User. - This can be passed either as a string or as a `user_name: 'value'` key-value entry in a hash. +: This resource accepts a single parameter, the User's username which uniquely identifies the User. +This can be passed either as a string or as a `user_name: 'value'` key-value entry in a hash. ## Properties `username` -: The user's username. +: The friendly name identifying the user. `user_id` -: The user's ID. +: The stable and unique string identifying the user. `user_arn` -: The Amazon Resource Name of the user. +: The Amazon Resource Name (ARN) that identifies the user. `access_keys` : An array of hashes each containing metadata about the user's Access Keys. @@ -56,8 +56,22 @@ end : The name of standalone IAM policies which are attached to the user. `attached_policy_arns` -: The arns of the standalone IAM policies which are attached to the user. +: The Amazon Resource Name (ARN) that identifies the user. +`user_path` +: The path to the user. + +`user_create_date` +: The date and time, in ISO 8601 date-time format, when the user was created. + +`user_password_last_used` +: The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an Amazon Web Services website. + +`permissions_boundary` +: The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for an entity. + +`user_tags` +: A list of tags that are associated with the user. * has_mfa_enabled * has_console_password @@ -95,7 +109,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -126,11 +142,10 @@ it { should have_console_password } ## AWS Permissions -Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the following permissions action set to allow: -`IAM:Client:GetUserResponse` -`IAM:Client:GetLoginProfileResponse` -`IAM:Client:ListMFADevicesResponse` -`IAM:Client:ListAccessKeysResponse` -`IAM:Client:ListUserPoliciesResponse` -`IAM:Client:ListAttachedUserPoliciesResponse` - +Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the following permissions action set to allow: +`IAM:Client:GetUserResponse` +`IAM:Client:GetLoginProfileResponse` +`IAM:Client:ListMFADevicesResponse` +`IAM:Client:ListAccessKeysResponse` +`IAM:Client:ListUserPoliciesResponse` +`IAM:Client:ListAttachedUserPoliciesResponse` diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_users.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_users.md index ac2ec2b09c..83add74f68 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_users.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_users.md @@ -14,9 +14,9 @@ Use the `aws_iam_users` InSpec audit resource to test properties of some or all For additional information, including details on parameters and properties, see the [AWS documentation on IAM Users](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -104,7 +104,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_virtual_mfa_devices.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_virtual_mfa_devices.md index c28582befc..1271ea9f14 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_virtual_mfa_devices.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_iam_virtual_mfa_devices.md @@ -16,9 +16,9 @@ This resource does not require any parameters. For additional information, including details on parameters and properties, see the [AWS documentation on IAM virtual MFA Devices](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-virtualmfadevice.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -130,4 +130,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="IAM:Client:ListVirtualMFADevicesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="IAM:Client:ListVirtualMFADevicesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_internet_gateway.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_internet_gateway.md index a41cabf169..be3d1e3088 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_internet_gateway.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_internet_gateway.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_internet_gateway` InSpec audit resource to test the properties of a single AWS internet gateway. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -102,7 +102,7 @@ end ## Matchers -This InSpec audit resource has the following special matcher. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +This InSpec audit resource has the following special matcher. For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist @@ -115,6 +115,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeInternetGatewaysResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeInternetGatewaysResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_internet_gateways.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_internet_gateways.md index 1e9026f248..39a8bc41b7 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_internet_gateways.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_internet_gateways.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_internet_gateways` InSpec audit resource to test the properties of all AWS internet gateways owned by the AWS account. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -85,7 +85,7 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### exist @@ -108,6 +108,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeInternetGatewaysResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeInternetGatewaysResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_kms_key.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_kms_key.md index b7fdc47a37..5bebdd1159 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_kms_key.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_kms_key.md @@ -18,9 +18,9 @@ Each AWS KMS Key is uniquely identified by its key_id or arn. For additional information, including details on parameters and properties, see the [AWS documentation on KS Keys](https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_kms_keys.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_kms_keys.md index 6a660405cb..53d082cd8f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_kms_keys.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_kms_keys.md @@ -18,9 +18,9 @@ AWS Key Management Service is integrated with several other AWS services to help For additional information, including details on parameters and properties, see the [AWS documentation on KS Keys](https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -70,7 +70,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -93,6 +95,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="KMS:Client:ListKeysResponse" %}} +{{% inspec-aws/aws_permissions_principal action="KMS:Client:ListKeysResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for AWS Key Management Service](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awskeymanagementservice.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda.md index 9b25070d5d..dba56f8b29 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_lambda` resource to test a specific AWS Lambda function. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -51,11 +51,11 @@ end ## Matchers -This InSpec audit resource uses the standard matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +This InSpec audit resource uses the standard matchers. For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ## AWS Permissions -{{% aws_permissions_principal action="Lambda:Client:GetFunctionResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Lambda:Client:GetFunctionResponse" %}} You can find detailed documentation at [AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/lambda-api-permissions-ref.html) diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_alias.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_alias.md index fbe318edc0..dd314647bb 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_alias.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_alias.md @@ -16,9 +16,9 @@ The `AWS::Lambda::Alias` resource creates an alias for a Lambda function version For additional information, including details on parameters and properties, see the [AWS documentation on AWS Lambda alias](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -80,9 +80,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -114,4 +114,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Lambda:Client:AliasConfiguration" %}} +{{% inspec-aws/aws_permissions_principal action="Lambda:Client:AliasConfiguration" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_aliases.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_aliases.md index 238821d61c..87a1bb6c51 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_aliases.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_aliases.md @@ -16,9 +16,9 @@ The `AWS::Lambda::Alias` resource creates an alias for a Lambda function version For additional information, including details on parameters and properties, see the [AWS documentation on AWS Lambda alias](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -88,7 +88,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -122,4 +122,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Lambda:Client:ListAliasesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Lambda:Client:ListAliasesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_code_signing_config.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_code_signing_config.md index 2a968daa72..3d7bcf47e8 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_code_signing_config.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_code_signing_config.md @@ -16,9 +16,9 @@ The `AWS::Lambda::CodeSigningConfig` resource specifies the details about a code For additional information, including details on parameters and properties, see the [AWS documentation on AWS SSM CodeSigningConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,9 +76,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Lambda:Client:GetCodeSigningConfigResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Lambda:Client:GetCodeSigningConfigResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_code_signing_configs.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_code_signing_configs.md index 163d01fdc9..1cc1da3f21 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_code_signing_configs.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_code_signing_configs.md @@ -16,9 +16,9 @@ The `AWS::Lambda::CodeSigningConfig` resource specifies the details about a code For additional information, including details on parameters and properties, see the [AWS documentation on AWS SSM CodeSigningConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,7 +86,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -120,4 +120,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Lambda:Client:ListCodeSigningConfigsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Lambda:Client:ListCodeSigningConfigsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_invoke_config.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_invoke_config.md index 9126a24a37..0b59050a60 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_invoke_config.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_invoke_config.md @@ -16,9 +16,9 @@ The AWS::Lambda::EventInvokeConfig resource configures options for asynchronous For additional information, including details on parameters and properties, see the [AWS documentation on AWS Lambda EventInvokeConfig.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -96,9 +96,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -130,4 +130,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Lambda:Client:FunctionEventInvokeConfig" %}} +{{% inspec-aws/aws_permissions_principal action="Lambda:Client:FunctionEventInvokeConfig" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_invoke_configs.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_invoke_configs.md index 54e8382e1e..6d1fe57565 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_invoke_configs.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_invoke_configs.md @@ -16,9 +16,9 @@ The AWS::Lambda::EventInvokeConfig resource configures options for asynchronous For additional information, including details on parameters and properties, see the [AWS documentation on AWS Lambda EventInvokeConfig.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -78,7 +78,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -102,4 +102,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Lambda:Client:ListFunctionEventInvokeConfigsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Lambda:Client:ListFunctionEventInvokeConfigsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_source_mapping.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_source_mapping.md index a891bd063f..dabe027fb3 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_source_mapping.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_source_mapping.md @@ -16,9 +16,9 @@ The `AWS::Lambda::EventSourceMapping` resource creates a mapping between an even For additional information, including details on parameters and properties, see the [AWS documentation on AWS Lambda EventSourceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -121,9 +121,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -155,4 +155,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Lambda:Client:EventSourceMappingConfiguration" %}} +{{% inspec-aws/aws_permissions_principal action="Lambda:Client:EventSourceMappingConfiguration" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_source_mappings.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_source_mappings.md index 4e8736a4bb..f558b893d9 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_source_mappings.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_event_source_mappings.md @@ -16,9 +16,9 @@ The `AWS::Lambda::EventSourceMapping` resource creates a mapping between an even For additional information, including details on parameters and properties, see the [AWS documentation on Athena Work Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -113,7 +113,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -147,4 +147,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Lambda:Client:ListEventSourceMappingsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Lambda:Client:ListEventSourceMappingsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_layer_version_permission.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_layer_version_permission.md index 65c6749b52..d93beb0388 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_layer_version_permission.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_layer_version_permission.md @@ -16,9 +16,9 @@ The `AWS::Lambda::LayerVersionPermission` resource adds permissions to the resou For additional information, including details on parameters and properties, see the [AWS documentation on AWS Lambda layer version permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -68,9 +68,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -102,4 +102,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Lambda:Client:GetLayerVersionPolicyResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Lambda:Client:GetLayerVersionPolicyResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_permission.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_permission.md index dc5f7e094d..48d5ee02e9 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_permission.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_permission.md @@ -16,9 +16,9 @@ The `AWS::Lambda::Permission` resource grants an AWS service or another account For additional information, including details on parameters and properties, see the [AWS documentation on AWS Lambda permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -77,10 +77,10 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + -The controls will pass if the `get` method returns at least one result. ## AWS Permissions -{{% aws_permissions_principal action="Lambda:Client:GetPolicyResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Lambda:Client:GetPolicyResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_permissions.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_permissions.md index 33d477c6e3..c8d3ed6adb 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_permissions.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_permissions.md @@ -16,9 +16,9 @@ The `AWS::Lambda::Permission` resource grants an AWS service or another account For additional information, including details on parameters and properties, see the [AWS documentation on AWS Lambda permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -71,10 +71,10 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + -The controls will pass if the `get` method returns at least one result. ## AWS Permissions -{{% aws_permissions_principal action="Lambda:Client:GetPolicyResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Lambda:Client:GetPolicyResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_version.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_version.md index 73a1c0d21d..c6a86d212b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_version.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_version.md @@ -16,9 +16,9 @@ The `AWS::Lambda::Version` resource creates a version from the current code and For additional information, including details on parameters and properties, see the [AWS documentation on AWS Lambda Version](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -101,9 +101,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -135,4 +135,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Lambda:Client:GetLayerVersionResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Lambda:Client:GetLayerVersionResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_versions.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_versions.md index 9cd21e5d17..670c3ed637 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_versions.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambda_versions.md @@ -16,9 +16,9 @@ The `AWS::Lambda::Version` resource creates a version from the current code and For additional information, including details on parameters and properties, see the [AWS documentation on AWS Lambda Version](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -93,7 +93,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -127,4 +127,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Lambda:Client:ListLayerVersionsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Lambda:Client:ListLayerVersionsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambdas.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambdas.md index 3e457d7aab..2ee240f5bd 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambdas.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_lambdas.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_lambdas` resource to test the collection of lambdas deployed into an account. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -64,11 +64,11 @@ end ## Matchers -This InSpec audit resource uses the standard matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +This InSpec audit resource uses the standard matchers. For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ## AWS Permissions -{{% aws_permissions_principal action="Lambda:Client:ListFunctionsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Lambda:Client:ListFunctionsResponse" %}} You can find detailed documentation at [AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/lambda-api-permissions-ref.html) diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_launch_configuration.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_launch_configuration.md index 579f65c6df..b45eb3ff72 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_launch_configuration.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_launch_configuration.md @@ -14,9 +14,9 @@ Use the `aws_launch_configuration` InSpec audit resource to test properties of a For additional information, including details on parameters and properties, see the [AWS documentation on Launch Configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -121,7 +121,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -143,5 +145,5 @@ end ## AWS Permissions -{{% aws_permissions_principal action="AutoScaling:Client:LaunchConfigurationsType" %}} +{{% inspec-aws/aws_permissions_principal action="AutoScaling:Client:LaunchConfigurationsType" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Auto Scaling Groups and launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/control-access-using-iam.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_logs_metric_filter.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_logs_metric_filter.md index 94ba4d00dd..bc34a9d394 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_logs_metric_filter.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_logs_metric_filter.md @@ -14,9 +14,9 @@ Use the `aws_logs_metric_filter` InSpec audit resource to test properties of a s For additional information, including details on parameters and properties, see the [AWS documentation on AWS Logs MetricFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -80,7 +80,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -114,4 +114,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatchLogs:Client:DescribeMetricFiltersResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatchLogs:Client:DescribeMetricFiltersResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_logs_metric_filters.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_logs_metric_filters.md index acfb6937d6..adae253d5e 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_logs_metric_filters.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_logs_metric_filters.md @@ -14,9 +14,9 @@ Use the `aws_logs_metric_filters` InSpec audit resource to test properties of mu For additional information, including details on parameters and properties, see the [AWS documentation on AWS Logs MetricFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -69,7 +69,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -103,4 +103,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="CloudWatchLogs:Client:DescribeMetricFiltersResponse" %}} +{{% inspec-aws/aws_permissions_principal action="CloudWatchLogs:Client:DescribeMetricFiltersResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_broker.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_broker.md index 7f4b086097..18a38e513f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_broker.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_broker.md @@ -14,9 +14,9 @@ Use the `aws_mq_broker` InSpec audit resource to test the properties of a single For additional information, including details on parameters and properties, see the [AWS documentation on AWS MQ Broker](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -136,7 +136,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The control pass if the `describe` method returns at least one result. @@ -170,4 +170,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="MQ:Client:DescribeBrokerResponse" %}} +{{% inspec-aws/aws_permissions_principal action="MQ:Client:DescribeBrokerResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_brokers.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_brokers.md index cbe8b4171b..61566cca51 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_brokers.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_brokers.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_mq_brokers` InSpec audit resource to test the properties of multiple AWS MQ Broker. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -94,7 +94,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The control pass if the `list` method returns at least one result. @@ -128,4 +128,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="MQ:Client:ListBrokersResponse" %}} +{{% inspec-aws/aws_permissions_principal action="MQ:Client:ListBrokersResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_configuration.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_configuration.md index 627cf41d47..512313fdf4 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_configuration.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_configuration.md @@ -14,9 +14,9 @@ Use the `aws_mq_configuration` InSpec audit resource to test the properties of a For additional information, including details on parameters and properties, see the [AWS documentation on AWS MQ configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -102,7 +102,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -136,4 +136,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="MQ:Client:DescribeConfigurationResponse" %}} +{{% inspec-aws/aws_permissions_principal action="MQ:Client:DescribeConfigurationResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_configurations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_configurations.md index 25b535b1b9..d834b1b359 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_configurations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_mq_configurations.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_mq_configurations` InSpec audit resource to test the properties of multiple AWS MQ configuration. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -99,7 +99,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -133,4 +133,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="MQ:Client:ListConfigurationsResponsegit" %}} +{{% inspec-aws/aws_permissions_principal action="MQ:Client:ListConfigurationsResponsegit" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_nat_gateway.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_nat_gateway.md index f0e83bfdb7..eab72b2a68 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_nat_gateway.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_nat_gateway.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_nat_gateway` InSpec audit resource to test the properties of a single AWS NAT gateway. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -132,11 +132,11 @@ describe aws_nat_gateway(vpc_id: 'vpc-abc01234', subnet_id: 'subnet-12345678') d end ``` -For more examples, please check the [integration tests](../../test/integration/verify/controls/aws_nat_gateway.rb). +For more examples, see the [integration tests](https://github.com/inspec/inspec-aws/blob/main/test/integration/verify/controls/aws_nat_gateway.rb). ## Matchers -This InSpec audit resource has the following special matcher. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +This InSpec audit resource has the following special matcher. For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist @@ -149,6 +149,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeNatGatewaysResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeNatGatewaysResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_nat_gateways.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_nat_gateways.md index f859db0f86..7aa3178e85 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_nat_gateways.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_nat_gateways.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_nat_gateways` InSpec audit resource to test the properties of all AWS NAT gateways owned by the AWS account. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -82,12 +82,11 @@ aws_nat_gateways.ids.each do |id| end ``` -For more examples, please check the [integration tests](../../test/integration/verify/controls/aws_nat_gateways.rb). - +For more examples, see the [integration tests](https://github.com/inspec/inspec-aws/blob/main/test/integration/verify/controls/aws_nat_gateways.rb). ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### exist @@ -112,6 +111,6 @@ Please see [here](https://github.com/inspec/inspec/blob/master/docs/dev/filterta ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeNatGatewaysResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeNatGatewaysResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_acl.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_acl.md index 1ec2f5e006..52f48539ec 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_acl.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_acl.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_network_acl` InSpec audit resource to test the properties of a single Amazon network ACL. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -145,7 +145,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -212,6 +214,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeNetworkAclsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeNetworkAclsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for network ACL](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-policy-examples.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_acls.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_acls.md index 81d81e6d86..986ec4a8cf 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_acls.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_acls.md @@ -13,9 +13,9 @@ parent = "inspec/resources/aws" Use the `aws_network_acls` InSpec audit resource to test the properties of all Amazon network ACLs. To audit a single network ACL, use the `aws_network_acl` (singular) resource. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -189,7 +189,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -211,6 +213,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeNetworkAclsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeNetworkAclsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon ElastiCache](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-policy-examples.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewall.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewall.md index 7582ec5bac..e7ad52f960 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewall.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewall.md @@ -16,9 +16,9 @@ The firewall defines the configuration settings for an AWS Network Firewall fire For additional information, including details on parameters and properties, see the [AWS documentation on AWS Network Firewall Firewall](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -121,7 +121,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -155,4 +155,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="NetworkFirewall:Client:DescribeFirewallResponse" %}} +{{% inspec-aws/aws_permissions_principal action="NetworkFirewall:Client:DescribeFirewallResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewall_policies.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewall_policies.md index 5e45b4f2a4..d9ef99145b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewall_policies.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewall_policies.md @@ -16,9 +16,9 @@ The firewall defines the configuration settings for an AWS Network Firewall fire For additional information, including details on parameters and properties, see the [AWS documentation on AWS Network Firewall Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -66,7 +66,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `List` method returns at least one result. @@ -90,4 +90,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="NetworkFirewall:Client:ListFirewallPoliciesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="NetworkFirewall:Client:ListFirewallPoliciesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewall_policy.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewall_policy.md index aa2f804b97..0c42fbcfb5 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewall_policy.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewall_policy.md @@ -16,9 +16,9 @@ The firewall defines the configuration settings for an AWS Network Firewall fire For additional information, including details on parameters and properties, see the [AWS documentation on AWS Network Firewall Firewall](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -109,7 +109,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -143,4 +143,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="NetworkFirewall:Client:DescribeFirewallPolicyResponse" %}} +{{% inspec-aws/aws_permissions_principal action="NetworkFirewall:Client:DescribeFirewallPolicyResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewalls.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewalls.md index d7cc038061..2a29e4cc8c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewalls.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_firewalls.md @@ -16,9 +16,9 @@ The firewall defines the configuration settings for an AWS Network Firewall fire For additional information, including details on parameters and properties, see the [AWS documentation on AWS Network Firewall Firewall](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -66,7 +66,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -100,4 +100,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="NetworkFirewall:Client:DescribeFirewallResponse" %}} +{{% inspec-aws/aws_permissions_principal action="NetworkFirewall:Client:DescribeFirewallResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_logging_configuration.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_logging_configuration.md index d0c6c580ed..97adbb5820 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_logging_configuration.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_logging_configuration.md @@ -16,9 +16,9 @@ The `AWS::NetworkFirewall::LoggingConfiguration` resource defines the destinatio For additional information, including details on parameters and properties, see the [AWS documentation on AWS Network Firewall Logging Configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -70,7 +70,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -104,4 +104,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="NetworkFirewall:Client:DescribeFirewallResponse" %}} +{{% inspec-aws/aws_permissions_principal action="NetworkFirewall:Client:DescribeFirewallResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_rule_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_rule_group.md index 2509796d9b..2b116db53c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_rule_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_rule_group.md @@ -16,9 +16,9 @@ The `AWS::NetworkFirewall::RuleGroup` resource defines a reusable collection of For additional information, including details on parameters and properties, see the [AWS documentation on AWS Network Firewall Rule Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -199,7 +199,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -233,4 +233,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="NetworkFirewall:Client:DescribeRuleGroupResponse" %}} +{{% inspec-aws/aws_permissions_principal action="NetworkFirewall:Client:DescribeRuleGroupResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_rule_groups.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_rule_groups.md index 14402d9827..6e842559d9 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_rule_groups.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_firewall_rule_groups.md @@ -16,9 +16,9 @@ The `AWS::NetworkFirewall::RuleGroup` resource defines a reusable collection of For additional information, including details on parameters and properties, see the [AWS documentation on AWS Network Firewall Rule Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -66,7 +66,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -90,4 +90,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="NetworkFirewall:Client:ListRuleGroupsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="NetworkFirewall:Client:ListRuleGroupsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_customer_gateway_association.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_customer_gateway_association.md index 47bf5875b3..2e5310e15c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_customer_gateway_association.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_customer_gateway_association.md @@ -16,9 +16,9 @@ The `AWS::NetworkManager::CustomerGatewayAssociation` resource specifies an asso For additional information, including details on parameters and properties, see the [AWS documentation on AWS Network Manager Customer Gateway Association.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-customergatewayassociation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -77,9 +77,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -111,4 +111,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="NetworkManager:Client:GetCustomerGatewayAssociationsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="NetworkManager:Client:GetCustomerGatewayAssociationsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_customer_gateway_associations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_customer_gateway_associations.md index 4365a321b4..0ea9ea2e8a 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_customer_gateway_associations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_customer_gateway_associations.md @@ -16,9 +16,9 @@ The `AWS::NetworkManager::CustomerGatewayAssociation` resource specifies an asso For additional information, including details on parameters and properties, see the [AWS documentation on AWS Network Manager Customer Gateway Association.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-customergatewayassociation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -83,9 +83,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -107,4 +107,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="NetworkManager:Client:GetCustomerGatewayAssociationsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="NetworkManager:Client:GetCustomerGatewayAssociationsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_device.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_device.md index 8de62ebadb..32c6273769 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_device.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_device.md @@ -16,9 +16,9 @@ The `AWS::NetworkManager::Device` resource gets information about one or more of For additional information, including details on parameters and properties, see the [AWS documentation on AWS Network Manager Device](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -129,9 +129,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -163,4 +163,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="NetworkManager:Client:GetDevicesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="NetworkManager:Client:GetDevicesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_devices.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_devices.md index 4a04a2ba03..dff37dd59b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_devices.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_devices.md @@ -16,9 +16,9 @@ The `AWS::NetworkManager::Device` resource gets information about one or more of For additional information, including details on parameters and properties, see the [AWS documentation on AWS Network Manager Device](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -154,9 +154,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -178,4 +178,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="NetworkManager:Client:GetDevicesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="NetworkManager:Client:GetDevicesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_global_network.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_global_network.md index 24fb3a0858..d30539d937 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_global_network.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_global_network.md @@ -16,9 +16,9 @@ The `AWS::NetworkManager::GlobalNetwork` resource describes one or more global n For additional information, including details on parameters and properties, see the [AWS documentation on AWS Network Manager Global Network](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-globalnetwork.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,9 +76,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="NetworkManager:Client:DescribeGlobalNetworksResponse" %}} +{{% inspec-aws/aws_permissions_principal action="NetworkManager:Client:DescribeGlobalNetworksResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_global_networks.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_global_networks.md index 5258da11b2..52a191ee25 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_global_networks.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_network_manager_global_networks.md @@ -16,9 +16,9 @@ The `AWS::NetworkManager::GlobalNetwork` resource describes one or more global n For additional information, including details on parameters and properties, see the [AWS documentation on AWS Network Manager Global Network](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-globalnetwork.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -74,9 +74,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -98,4 +98,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="NetworkManager:Client:DescribeGlobalNetworksResponse" %}} +{{% inspec-aws/aws_permissions_principal action="NetworkManager:Client:DescribeGlobalNetworksResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_organizations_member.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_organizations_member.md index e7ddf69e1d..39e75c3186 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_organizations_member.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_organizations_member.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_organizations_member` InSpec audit resource to test the current AWS Account being used within an organization. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -75,7 +75,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### be_master diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ram_resource_share.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ram_resource_share.md index 2c7b1a7d0c..d79fbfd868 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ram_resource_share.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ram_resource_share.md @@ -14,9 +14,9 @@ Use the `aws_ram_resource_share` InSpec audit resource to test properties of a s For additional information, including details on parameters and properties, see the [AWS documentation on AWS RAM Resource Share](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -90,9 +90,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -124,4 +124,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RAM:Client:GetResourceSharesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="RAM:Client:GetResourceSharesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ram_resource_shares.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ram_resource_shares.md index 82901eb62a..a2ed131040 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ram_resource_shares.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ram_resource_shares.md @@ -14,9 +14,9 @@ Use the `aws_ram_resource_shares` InSpec audit resource to test properties of mu For additional information, including details on parameters and properties, see the [AWS documentation on AWS RAM Resource Share](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,9 +86,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -120,4 +120,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RAM:Client:GetResourceSharesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="RAM:Client:GetResourceSharesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_cluster.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_cluster.md index a10fc265d4..9d3a58fe3e 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_cluster.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_cluster.md @@ -16,9 +16,9 @@ RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Micros For additional information, including details on parameters and properties, see the [AWS documentation on RDS cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -88,7 +88,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -110,6 +112,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DBClusterMessage" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DBClusterMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon RDS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonrds.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_clusters.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_clusters.md index 804116d459..7e7f038527 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_clusters.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_clusters.md @@ -14,9 +14,9 @@ Use the `aws_rds_clusters` InSpec audit resource to test properties of a collect RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -89,7 +89,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -111,6 +113,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DBClusterMessage" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DBClusterMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_cluster_snapshot.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_cluster_snapshot.md index f0fbb9f320..c011a33b0c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_cluster_snapshot.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_cluster_snapshot.md @@ -14,9 +14,9 @@ Use the `aws_rds_db_cluster_snapshot` InSpec audit resource to test the properti For additional information, including details on parameters and properties, see the [AWS documentation on AWS RDS Cluster Snapshot.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_RDS.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -119,7 +119,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The control passes if the `describe` method returns at least one result. @@ -153,4 +153,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DBClusterSnapshotMessage" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DBClusterSnapshotMessage" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_cluster_snapshots.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_cluster_snapshots.md index 2001480d4d..b5919996b0 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_cluster_snapshots.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_cluster_snapshots.md @@ -14,9 +14,9 @@ Use the `aws_rds_db_cluster_snapshots` InSpec audit resource to test the propert For additional information, including details on parameters and properties, see the [AWS documentation on AWS RDS Cluster Snapshot.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_RDS.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -159,7 +159,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The control passes if the `describe` method returns at least one result. @@ -193,4 +193,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DBClusterSnapshotMessage" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DBClusterSnapshotMessage" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy.md index fc3c16335c..5edea70b5f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy.md @@ -16,9 +16,9 @@ The `AWS::RDS::DBProxy` resource creates or updates an RDS DB proxy. For additional information, including details on parameters and properties, see the [AWS documentation on AWS RDS DBProxy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -123,7 +123,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -157,4 +157,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DescribeDBProxiesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DescribeDBProxiesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_endpoint.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_endpoint.md index 0f0714f4c1..43a5ac61e5 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_endpoint.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_endpoint.md @@ -16,9 +16,9 @@ The `AWS::RDS::DBProxyEndpoint` resource creates or updates an AWS RDS DB proxy For additional information, including details on parameters and properties, see the [AWS documentation on AWS RDS DBProxyEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -103,7 +103,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -137,4 +137,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DescribeDBProxyEndpointsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DescribeDBProxyEndpointsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_endpoints.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_endpoints.md index f7a120a04d..8a7094ec80 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_endpoints.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_endpoints.md @@ -16,9 +16,9 @@ The `AWS::RDS::DBProxyEndpoint` resource creates or updates an AWS RDS DB proxy For additional information, including details on parameters and properties, see the [AWS documentation on AWS RDS DBProxyEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -121,7 +121,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -155,4 +155,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DescribeDBProxyEndpointsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DescribeDBProxyEndpointsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_target_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_target_group.md index 54f43bad69..88cac81bac 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_target_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_target_group.md @@ -16,9 +16,9 @@ The `AWS::RDS::DBProxyTargetGroup` resource represents a set of RDS DB instances For additional information, including details on parameters and properties, see the [AWS documentation on AWS RDS DBProxyTargetGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -106,7 +106,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -140,4 +140,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DescribeDBProxyTargetGroupsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DescribeDBProxyTargetGroupsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_target_groups.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_target_groups.md index 3811fb12a0..190de97047 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_target_groups.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_proxy_target_groups.md @@ -16,9 +16,9 @@ The `AWS::RDS::DBProxyTargetGroup` resource represents a set of RDS DB instances For additional information, including details on parameters and properties, see the [AWS documentation on AWS RDS DBProxyTargetGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -106,7 +106,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -140,4 +140,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DescribeDBProxyTargetGroupsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DescribeDBProxyTargetGroupsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_security_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_security_group.md index 360e742578..5a8013b066 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_security_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_security_group.md @@ -14,9 +14,9 @@ Use the `aws_rds_db_security_group` InSpec audit resource to test properties of For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::RDS::DBSecurityGroup` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -124,7 +124,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -158,4 +158,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DescribeDBSecurityGroup" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DescribeDBSecurityGroup" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_security_groups.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_security_groups.md index cd3b1ca22d..45993de86e 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_security_groups.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_db_security_groups.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_rds_db_security_groups` InSpec audit resource to test properties of multiple Amazon Relational Database Service (RDS) database security groups. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -75,7 +75,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -109,4 +109,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DescribeDBSecurityGroup" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DescribeDBSecurityGroup" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_event_subscription.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_event_subscription.md index d1c016c114..b99ee9735f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_event_subscription.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_event_subscription.md @@ -14,9 +14,9 @@ Use the `aws_rds_event_subscription` InSpec audit resource to test properties of For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::RDS::EventSubscription` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -94,7 +94,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -128,4 +128,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DescribeEventSubscriptionsMessage" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DescribeEventSubscriptionsMessage" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_event_subscriptions.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_event_subscriptions.md index c9f49f6230..64d39f54f9 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_event_subscriptions.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_event_subscriptions.md @@ -14,9 +14,9 @@ Use the `aws_rds_event_subscriptions` InSpec audit resource to test properties o For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::RDS::EventSubscription` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -112,7 +112,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -146,4 +146,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DescribeDBSecurityGroup" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DescribeDBSecurityGroup" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_global_cluster.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_global_cluster.md index eb7192d173..896c883438 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_global_cluster.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_global_cluster.md @@ -16,9 +16,9 @@ The `AWS::RDS::GlobalCluster` resource creates or updates an Amazon Aurora globa For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::RDS::GlobalCluster` resource type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -114,7 +114,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -148,4 +148,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DescribeGlobalClustersMessage" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DescribeGlobalClustersMessage" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_global_clusters.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_global_clusters.md index f6ef1fdf89..041181e24c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_global_clusters.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_global_clusters.md @@ -14,9 +14,9 @@ Use the `aws_rds_global_clusters` InSpec audit resource to test properties of mu The AWS::RDS::GlobalCluster resource creates or updates an Amazon Aurora global database spread across multiple AWS Regions. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -105,7 +105,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -139,4 +139,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DescribeGlobalClustersMessage" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DescribeGlobalClustersMessage" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_group_option.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_group_option.md index cad0ab8215..f3cf40d499 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_group_option.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_group_option.md @@ -16,9 +16,9 @@ RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Micros For additional information, including details on parameters and properties, see the [AWS documentation on RDS Option Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -91,7 +91,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -113,6 +115,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:OptionGroups" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:OptionGroups" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon RDS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonrds.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_group_options.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_group_options.md index a3234377f2..89c675ec2d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_group_options.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_group_options.md @@ -14,9 +14,9 @@ Use the `aws_rds_group_options` InSpec audit resource to test detailed propertie RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -72,7 +72,7 @@ This resource does not require any parameters. : The storage allocated to each cluster. : **Field**: `allows_vpc_and_non_vpc_instance_memberships` -See also the [AWS documentation on RDS cluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html). +See the [AWS documentation on RDS cluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html). For a comprehensive list of properties available to test on an RDS cluster see the [AWS Response Object](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBCluster.html). @@ -108,7 +108,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -130,6 +132,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:OptionGroups" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:OptionGroups" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon RDS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonrds.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_instance.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_instance.md index 1a447011be..88922f3ac3 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_instance.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_instance.md @@ -16,9 +16,9 @@ RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Micros For additional information, including details on parameters and properties, see the [AWS documentation on RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -93,7 +93,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -115,6 +117,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DBInstanceMessage" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DBInstanceMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon RDS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonrds.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_instances.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_instances.md index 3aa3cdd0ea..0482d1e122 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_instances.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_instances.md @@ -16,9 +16,9 @@ RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Micros RDS instances are compute instances used by the RDS service. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -75,7 +75,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -97,6 +99,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DBInstanceMessage" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DBInstanceMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_snapshot.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_snapshot.md index d93b6946fd..c32086e15b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_snapshot.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_snapshot.md @@ -14,9 +14,9 @@ Use the `aws_rds_snapshot` InSpec audit resource to test the detailed properties For additional information, including details on parameters and properties, see the [AWS documentation on RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -102,7 +102,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -124,6 +126,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DBSnapshotMessage" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DBSnapshotMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon RDS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonrds.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_snapshot_attributes.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_snapshot_attributes.md index d24e3c099b..b6b3dcca72 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_snapshot_attributes.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_snapshot_attributes.md @@ -14,9 +14,9 @@ Use the `aws_rds_snapshotattributes` InSpec audit resource to test the detailed For additional information, including details on parameters and properties, see the [AWS documentation on RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,7 +76,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -98,6 +100,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DescribeDBSnapshotAttributesResult" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DescribeDBSnapshotAttributesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon RDS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonrds.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_snapshots.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_snapshots.md index b724302af2..2ad78821f8 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_snapshots.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_rds_snapshots.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_rds_snapshots` InSpec audit resource to test the properties of a collection of AWS RDS snapshots. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -84,7 +84,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -106,6 +108,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="RDS:Client:DBSnapshotMessage" %}} +{{% inspec-aws/aws_permissions_principal action="RDS:Client:DBSnapshotMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_cluster.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_cluster.md index f08d9718f1..c12dfe0fc9 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_cluster.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_cluster.md @@ -13,9 +13,9 @@ parent = "inspec/resources/aws" Use the `aws_redshift_cluster` InSpec audit resource to test detailed properties of an individual AWS Redshift cluster. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -124,7 +124,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -146,6 +148,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Redshift:Client:ClustersMessage" %}} +{{% inspec-aws/aws_permissions_principal action="Redshift:Client:ClustersMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Redshift](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonRedshift.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_cluster_parameter_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_cluster_parameter_group.md index 9f7194595f..4e27523a06 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_cluster_parameter_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_cluster_parameter_group.md @@ -16,9 +16,9 @@ A Redshift cluster parameter group is uniquely identified by the parameter group For additional information, including details on parameters and properties, see the [AWS documentation on Redshift cluster parameter group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -68,7 +68,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -110,6 +110,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Redshift:Client:ClusterParameterGroupsMessage" %}} +{{% inspec-aws/aws_permissions_principal action="Redshift:Client:ClusterParameterGroupsMessage" %}} See the [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html) documentation for additional information. diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_cluster_parameter_groups.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_cluster_parameter_groups.md index bc0f9a6d3f..fe81b8cc91 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_cluster_parameter_groups.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_cluster_parameter_groups.md @@ -16,9 +16,9 @@ This resource does not expect any parameters. For additional information, including details on parameters and properties, see the [AWS documentation on Redshift cluster parameter group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -84,7 +84,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -106,6 +108,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Redshift:Client:ClusterParameterGroupsMessage" %}} +{{% inspec-aws/aws_permissions_principal action="Redshift:Client:ClusterParameterGroupsMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_clusters.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_clusters.md index c88ed8dbf4..dbc750ffe1 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_clusters.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_redshift_clusters.md @@ -14,9 +14,9 @@ Use the `aws_redshift_clusters` InSpec audit resource to test properties of a co Redshift gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -128,7 +128,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -152,6 +154,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Redshift:Client:ClustersMessage" %}} +{{% inspec-aws/aws_permissions_principal action="Redshift:Client:ClustersMessage" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_region.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_region.md index 56ffdfe19a..f1ad2f51f3 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_region.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_region.md @@ -14,9 +14,9 @@ Use the `aws_region` InSpec audit resource to test properties of a single AWS re For additional information, including details on parameters and properties, see the [AWS documentation on Regions](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -69,7 +69,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -81,6 +83,6 @@ it { should exist } ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeRegionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeRegionsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_regions.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_regions.md index 52f2c24c2a..2badf26b1c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_regions.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_regions.md @@ -16,9 +16,9 @@ Note that this resource lists all AWS regions that are currently available to th For additional information, including details on parameters and properties, see the [AWS documentation on Regions](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -77,7 +77,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist @@ -91,6 +91,6 @@ it { should exist } ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeRegionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeRegionsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53_record_set.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53_record_set.md index ee8444ffd6..5cc47e504b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53_record_set.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53_record_set.md @@ -16,9 +16,9 @@ The `AWS::Route53::RecordSet` resource specifies information about the record th For additional information, including details on parameters and properties, see the [AWS documentation on AWS Route53 Record Set](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -113,7 +113,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -147,4 +147,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Route53:Client:ListResourceRecordSetsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Route53:Client:ListResourceRecordSetsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53_record_sets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53_record_sets.md index 3979c5aae3..9e4087285e 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53_record_sets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53_record_sets.md @@ -16,9 +16,9 @@ The `AWS::Route53::RecordSet` type can be used as a standalone resource or as an For additional information, including details on parameters and properties, see the [AWS documentation on AWS Route53 Record Set](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -123,7 +123,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -147,4 +147,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Route53:Client:ListResourceRecordSetsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Route53:Client:ListResourceRecordSetsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_endpoint.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_endpoint.md index 0814949a73..594d238620 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_endpoint.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_endpoint.md @@ -16,9 +16,9 @@ There are two types of Resolver endpoints, inbound and outbound. An inbound Reso For additional information, including details on parameters and properties, see the [AWS documentation on AWS Route53Resolver Resolver Endpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -94,9 +94,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -128,4 +128,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Route53Resolver:Client:GetResolverEndpointResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Route53Resolver:Client:GetResolverEndpointResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_endpoints.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_endpoints.md index d4fa3aba91..f7f14dbd18 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_endpoints.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_endpoints.md @@ -16,9 +16,9 @@ There are two types of Resolver endpoints, inbound and outbound. An inbound Reso For additional information, including details on parameters and properties, see the [AWS documentation on AWS Route53Resolver Resolver Endpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -92,7 +92,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -126,4 +126,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Route53Resolver:Client:ListResolverEndpointsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Route53Resolver:Client:ListResolverEndpointsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rule.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rule.md index 1b91fdb346..ffdefb8ee8 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rule.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rule.md @@ -16,9 +16,9 @@ The AWS Route53 Resolver Rule resource specifies which Resolver endpoint the que For additional information, including details on parameters and properties, see the [AWS documentation on AWS Route53 Resolver rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -103,9 +103,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -137,4 +137,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Route53Resolver:Client:GetResolverRuleResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Route53Resolver:Client:GetResolverRuleResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rule_association.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rule_association.md index 9ae9428353..63fb8e8961 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rule_association.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rule_association.md @@ -16,9 +16,9 @@ The Resolver rule association determines which DNS queries that originate in the For additional information, including details on parameters and properties, see the [AWS documentation on AWS Route53Resolver Resolver Rule Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,9 +76,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Route53Resolver:Client:GetResolverRuleAssociationResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Route53Resolver:Client:GetResolverRuleAssociationResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rule_associations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rule_associations.md index 54993da572..4e07e15438 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rule_associations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rule_associations.md @@ -16,9 +16,9 @@ The Resolver rule association determines which DNS queries that originate in the For additional information, including details on parameters and properties, see the [AWS documentation on AWS Route53Resolver Resolver Rule Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverruleassociation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -74,7 +74,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -108,4 +108,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Route53Resolver:Client:ListResolverRuleAssociationsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Route53Resolver:Client:ListResolverRuleAssociationsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rules.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rules.md index b6ca26817d..a5789fd691 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rules.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route53resolver_resolver_rules.md @@ -16,9 +16,9 @@ The AWS Route53 Resolver Rule resource specifies which Resolver endpoint the que For additional information, including details on parameters and properties, see the [AWS documentation on AWS Route53 Resolver Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -98,7 +98,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -132,4 +132,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Route53Resolver:Client:ListResolverRulesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Route53Resolver:Client:ListResolverRulesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route_table.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route_table.md index 0940c6ed88..5ce0ee7b0a 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route_table.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route_table.md @@ -14,9 +14,9 @@ Use the `aws_route_table` InSpec audit resource to test the properties of a sing For additional information, including details on parameters and properties, see the [AWS documentation on route tables](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route-table.html) and the [AWS documentation on routes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationcidrblock). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -183,7 +183,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist @@ -258,6 +258,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeRouteTablesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeRouteTablesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route_tables.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route_tables.md index ff1aac4db7..f3897ae943 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route_tables.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_route_tables.md @@ -14,9 +14,9 @@ Use the `aws_route_tables` InSpec audit resource to test the properties of all r For additional information, including details on parameters and properties, see the [AWS documentation on route tables](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route-table.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -223,6 +223,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeRouteTablesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeRouteTablesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_access_point.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_access_point.md index 6f8ac01bed..40c3f8ee4a 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_access_point.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_access_point.md @@ -14,9 +14,9 @@ Use the `aws_s3_access_point` InSpec audit resource to test properties of a sing For additional information, including details on parameters and properties, see the [AWS documentation on AWS API Metric.](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -75,9 +75,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -109,4 +109,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="S3:Client:GetBucketMetricsConfigurationOutput" %}} +{{% inspec-aws/aws_permissions_principal action="S3:Client:GetBucketMetricsConfigurationOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_access_points.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_access_points.md index 67461954cb..2ae2e1ca88 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_access_points.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_access_points.md @@ -14,9 +14,9 @@ Use the `aws_s3_access_points` InSpec audit resource to test properties of a Mul For additional information, including details on parameters and properties, see the [AWS documentation on AWS S3 Access Points.](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -71,7 +71,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -105,4 +105,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="S3:Client:listBucketMetricsConfigurationOutput" %}} +{{% inspec-aws/aws_permissions_principal action="S3:Client:listBucketMetricsConfigurationOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket.md index fc81a2db0d..0a2e28f94d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket.md @@ -14,9 +14,9 @@ Use the `aws_s3_bucket` InSpec audit resource to test properties of a single AWS For additional information, including details on parameters and properties, see the [AWS documentation on S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -148,7 +148,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. #### be_public diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket_object.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket_object.md index 8f04b7d335..421fa62e7f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket_object.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket_object.md @@ -16,9 +16,9 @@ Each S3 Object has a 'key' which can be thought of as the name of the S3 Object For additional information, including details on parameters and properties, see the [AWS documentation on S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket_objects.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket_objects.md index 9c6e0f9f2a..0906db985b 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket_objects.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket_objects.md @@ -20,9 +20,9 @@ The bucket name. For additional information, including details on parameters and properties, see the [AWS documentation on S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -164,7 +164,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -188,4 +188,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="S3:Client:ListObjectsV2Output" %}} +{{% inspec-aws/aws_permissions_principal action="S3:Client:ListObjectsV2Output" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket_policy.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket_policy.md index dca56101b7..a7c0d52206 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket_policy.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_bucket_policy.md @@ -16,9 +16,9 @@ The `AWS::S3::BucketPolicy` resource type applies an Amazon S3 bucket policy to For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::S3::BucketPolicy` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -68,9 +68,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -102,4 +102,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="S3:Client:GetBucketPolicyOutput" %}} +{{% inspec-aws/aws_permissions_principal action="S3:Client:GetBucketPolicyOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_buckets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_buckets.md index b1908d736e..a78b0dbf1d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_buckets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_s3_buckets.md @@ -14,9 +14,9 @@ Use the `aws_s3_buckets` InSpec audit resource to list all buckets in a single a For additional information, including details on parameters and properties, see the [AWS documentation on S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -80,6 +80,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="S3:Client:ListBucketsOutput" %}} +{{% inspec-aws/aws_permissions_principal action="S3:Client:ListBucketsOutput" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sdb_domains.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sdb_domains.md index f52debd176..4457095311 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sdb_domains.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sdb_domains.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_sdb_domains` InSpec audit resource to test multiple SimpleDB domain names. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -52,7 +52,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -76,4 +76,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SimpleDB:Client:ListDomainsResult" %}} +{{% inspec-aws/aws_permissions_principal action="SimpleDB:Client:ListDomainsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_secretsmanager_secret.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_secretsmanager_secret.md index bd24a75a54..ce9090f5e8 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_secretsmanager_secret.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_secretsmanager_secret.md @@ -16,9 +16,9 @@ The `AWS::SecretsManager::Secret` resource creates a secret and stores it in Sec For additional information, including details on parameters and properties, see the [AWS documentation on AWS Secret Manager Secret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -104,7 +104,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -138,4 +138,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SecretsManager:Client:DescribeSecretResponse" %}} +{{% inspec-aws/aws_permissions_principal action="SecretsManager:Client:DescribeSecretResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_secretsmanager_secrets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_secretsmanager_secrets.md index bd7a1c20fe..f4f078a8d0 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_secretsmanager_secrets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_secretsmanager_secrets.md @@ -16,9 +16,9 @@ The `AWS::SecretsManager::Secret` resource creates a secret and stores it in Sec For additional information, including details on parameters and properties, see the [AWS documentation on AWS Secret Manager Secret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -104,7 +104,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -138,4 +138,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SecretsManager:Client:ListSecretsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="SecretsManager:Client:ListSecretsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_security_group.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_security_group.md index 4984f60e64..a56a7d3a43 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_security_group.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_security_group.md @@ -48,9 +48,9 @@ This must be passed as a key-value entry in a hash. For example, `resource_data: For additional information, including details on parameters and properties, see the [AWS documentation on Security Groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -327,6 +327,6 @@ it { should_not exist } ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeSecurityGroupsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeSecurityGroupsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_security_groups.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_security_groups.md index fcb8d46540..55b5971ad1 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_security_groups.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_security_groups.md @@ -16,9 +16,9 @@ Security groups are a networking construct that contain ingress and egress rules For additional information, including details on parameters and properties, see the [AWS documentation on Security Groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -104,7 +104,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -121,6 +123,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeSecurityGroupsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeSecurityGroupsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_securityhub_hub.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_securityhub_hub.md index 3c88cc837c..cb9bb70a70 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_securityhub_hub.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_securityhub_hub.md @@ -14,9 +14,9 @@ Use the `aws_securityhub_hub` InSpec audit resource to test properties of a sing For additional information, including details on parameters and properties, see the [AWS documentation on AWS Security Hub](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeHub.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -65,7 +65,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -99,4 +99,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SecurityHub:Client:DescribeHubResponse" %}} +{{% inspec-aws/aws_permissions_principal action="SecurityHub:Client:DescribeHubResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_cloud_formation_product.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_cloud_formation_product.md index 023ea279fd..60db77b701 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_cloud_formation_product.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_cloud_formation_product.md @@ -14,9 +14,9 @@ Use the `aws_servicecatalog_cloud_formation_product` InSpec audit resource to te For additional information, including details on parameters and properties, see the [AWS documentation on AWS Service Catalog CloudFormation product](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -89,7 +89,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -123,4 +123,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ServiceCatalog:Client:DescribeProductAsAdminOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ServiceCatalog:Client:DescribeProductAsAdminOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_launch_role_constraint.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_launch_role_constraint.md index c3b7721ce1..615d5e4c20 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_launch_role_constraint.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_launch_role_constraint.md @@ -14,9 +14,9 @@ Use the `aws_servicecatalog_launch_role_constraint` InSpec audit resource to tes For additional information, including details on parameters and properties, see the [AWS documentation on AWS Service Catalog launch role constraint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -80,7 +80,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -114,4 +114,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ServiceCatalog:Client:DescribeConstraintOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ServiceCatalog:Client:DescribeConstraintOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_launch_role_constraints.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_launch_role_constraints.md index 791cf5d798..68977325df 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_launch_role_constraints.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_launch_role_constraints.md @@ -14,9 +14,9 @@ Use the `aws_servicecatalog_launch_role_constraints` InSpec audit resource to te For additional information, including details on parameters and properties, see the [AWS documentation on AWS ServiceCatalog LaunchRoleConstraint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -74,7 +74,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -98,4 +98,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ServiceCatalog:Client:ListConstraintsForPortfolioOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ServiceCatalog:Client:ListConstraintsForPortfolioOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_principal_association.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_principal_association.md index 65267bb82f..c632838467 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_principal_association.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_principal_association.md @@ -14,9 +14,9 @@ Use the `aws_servicecatalog_portfolio_principal_association` InSpec audit resour For additional information, including details on parameters and properties, see the [AWS documentation on AWS Service Catalog Portfolio Principal Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioprincipalassociation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -62,7 +62,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -96,4 +96,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ServiceCatalog:Client:ListPrincipalsForPortfolioOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ServiceCatalog:Client:ListPrincipalsForPortfolioOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_principal_associations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_principal_associations.md index 97a1d5f885..496fc08803 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_principal_associations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_principal_associations.md @@ -14,9 +14,9 @@ Use the `aws_servicecatalog_portfolio_principal_associations` InSpec audit resou For additional information, including details on parameters and properties, see the [AWS documentation on AWS Service Catalog Portfolio Principal Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioprincipalassociation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -62,7 +62,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -86,4 +86,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ServiceCatalog:Client:ListPrincipalsForPortfolioOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ServiceCatalog:Client:ListPrincipalsForPortfolioOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_product_association.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_product_association.md index 0b43ca7e5c..71ae7c0a26 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_product_association.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_product_association.md @@ -14,9 +14,9 @@ Use the `aws_servicecatalog_portfolio_product_association` InSpec audit resource For additional information, including details on parameters and properties, see the [AWS documentation on AWS Service Catalog Portfolio Product Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioproductassociation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -74,7 +74,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -98,4 +98,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ServiceCatalog:Client:ListPortfoliosForProductOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ServiceCatalog:Client:ListPortfoliosForProductOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_product_associations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_product_associations.md index 478accc1ac..1b8cb44221 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_product_associations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_servicecatalog_portfolio_product_associations.md @@ -14,9 +14,9 @@ Use the `aws_servicecatalog_portfolio_product_associations` InSpec audit resourc For additional information, including details on parameters and properties, see the [AWS documentation on AWS Service Catalog Portfolio Product Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioproductassociation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -74,7 +74,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -98,4 +98,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="ServiceCatalog:Client:ListPortfoliosForProductOutput" %}} +{{% inspec-aws/aws_permissions_principal action="ServiceCatalog:Client:ListPortfoliosForProductOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_receipt_rule.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_receipt_rule.md index 357a72cd13..ffebc1bb81 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_receipt_rule.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_receipt_rule.md @@ -16,9 +16,9 @@ The `AWS::SES::ReceiptRule` resource specifies a receipt rule. For additional information, including details on parameters and properties, see the [AWS documentation on AWS SES ReceiptRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -140,7 +140,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -174,4 +174,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SES:Client:DescribeReceiptRuleResponse" %}} +{{% inspec-aws/aws_permissions_principal action="SES:Client:DescribeReceiptRuleResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_receipt_rule_set.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_receipt_rule_set.md index be24084fe8..098412d562 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_receipt_rule_set.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_receipt_rule_set.md @@ -16,9 +16,9 @@ The `AWS::SES::ReceiptRuleSet` resource specifies a receipt rule set. For additional information, including details on parameters and properties, see the [AWS documentation on AWS SES ReceiptRuleSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptruleset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -136,7 +136,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -170,4 +170,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SES:Client:DescribeReceiptRuleSetResponse" %}} +{{% inspec-aws/aws_permissions_principal action="SES:Client:DescribeReceiptRuleSetResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_receipt_rule_sets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_receipt_rule_sets.md index cdafd1ea83..bcbac49be3 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_receipt_rule_sets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_receipt_rule_sets.md @@ -16,9 +16,9 @@ The `AWS::SES::ReceiptRuleSet` resource specifies a receipt rule set. For additional information, including details on parameters and properties, see the [AWS documentation on AWS SES ReceiptRuleSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptruleset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -58,7 +58,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -82,4 +82,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SES:Client:ListReceiptRuleSetsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="SES:Client:ListReceiptRuleSetsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_template.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_template.md index 17506c4e3f..4258f2cf58 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_template.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_template.md @@ -16,9 +16,9 @@ The `AWS::SES::Template` resource specifies an email template. For additional information, including details on parameters and properties, see the [AWS documentation on AWS SES Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-template.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,9 +86,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -120,4 +120,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SES:Client:GetTemplateResponse" %}} +{{% inspec-aws/aws_permissions_principal action="SES:Client:GetTemplateResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_templates.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_templates.md index de3a79564f..5be093c6af 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_templates.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ses_templates.md @@ -16,9 +16,9 @@ The `AWS::SES::Template` resource specifies an email template. For additional information, including details on parameters and properties, see the [AWS documentation on AWS SES Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-template.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -58,7 +58,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -82,4 +82,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SES:Client:ListTemplatesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="SES:Client:ListTemplatesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_shield_subscription.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_shield_subscription.md index f375f428bd..4647bfd06d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_shield_subscription.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_shield_subscription.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_shield_subscription` InSpec audit resource to test properties of an AWS Shield Advanced subscription. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -65,10 +65,10 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ## AWS Permissions -{{% aws_permissions_principal action="Shield:Client:DescribeSubscriptionResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Shield:Client:DescribeSubscriptionResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Shield](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awsshield.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_signer_profile_permissions.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_signer_profile_permissions.md index 16c276e993..cb6b8e77bc 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_signer_profile_permissions.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_signer_profile_permissions.md @@ -16,9 +16,9 @@ The `AWS::Signer::ProfilePermission` resource adds cross-account permissions to For additional information, including details on parameters and properties, see the [AWS documentation on AWS Signer ProfilePermission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-profilepermission.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,7 +86,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Signer:Client:ListProfilePermissionsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Signer:Client:ListProfilePermissionsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_signer_signing_profile.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_signer_signing_profile.md index 65f211b313..8ebd1ffc48 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_signer_signing_profile.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_signer_signing_profile.md @@ -16,9 +16,9 @@ A signing profile is a code signing template that can be used to carry out a pre For additional information, including details on parameters and properties, see the [AWS documentation on AWS Signer SigningProfile.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -123,9 +123,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -157,4 +157,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Signer:Client:GetSigningProfileResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Signer:Client:GetSigningProfileResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_signer_signing_profiles.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_signer_signing_profiles.md index d5a2ac91b5..777d6e614e 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_signer_signing_profiles.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_signer_signing_profiles.md @@ -16,9 +16,9 @@ A signing profile is a code signing template that can be used to carry out a pre For additional information, including details on parameters and properties, see the [AWS documentation on AWS Signer SigningProfile.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -124,7 +124,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -148,4 +148,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Signer:Client:ListSigningProfilesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Signer:Client:ListSigningProfilesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_subscription.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_subscription.md index 137fb86ff9..9c11847aee 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_subscription.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_subscription.md @@ -14,9 +14,9 @@ Use the `aws_sns_subscription` InSpec audit resource to test detailed properties For additional information, including details on parameters and properties, see the [AWS documentation on SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-getting-started.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -32,28 +32,28 @@ end `subscription_arn` _(required)_ -: This resource accepts a single parameter, the subscription_arn. +: This resource accepts a single parameter, the subscription_arn. This can be passed either as a string or as a `subscription_arn: 'value'` key-value entry in a hash. ## Properties `arn` -: An integer indicating the minimum number of instances in the auto scaling group. +: The subscription's ARN. `owner` -: An integer indicating the maximum number of instances in the auto scaling group. +: The subscription's owner. `raw_message_delivery` -: An integer indicating the desired number of instances in the auto scaling group. +: Indicates whether the subscription is raw or JSON. `topic_arn` -: The name of the auto scaling launch configuration associated with the auto scaling group. +: The ARN of the subscription's topic. `protocol` -: An array of strings corresponding to the subnet IDs associated with the auto scaling group. +: The subscription's protocol. `confirmation_was_authenticated` -: An hash with each key-value pair corresponding to a tag associated with the entity. +: Indicates whether the subscription confirmation request was authenticated. ## Examples @@ -130,6 +130,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SNS:Client:GetSubscriptionAttributesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="SNS:Client:GetSubscriptionAttributesResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon SNS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonsns.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_subscriptions.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_subscriptions.md index d8f79e51f6..404408c30d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_subscriptions.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_subscriptions.md @@ -16,9 +16,9 @@ The `AWS::SNS::Subscription` resource subscribes an endpoint to an Amazon SNS to For additional information, including details on parameters and properties, see the [AWS documentation on AWS SNS subscriptions.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -81,7 +81,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -115,4 +115,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SNS:Client:ListSubscriptionsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="SNS:Client:ListSubscriptionsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_topic.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_topic.md index 10cfa11834..b1a1bb49a7 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_topic.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_topic.md @@ -14,9 +14,9 @@ Use the `aws_sns_topic` InSpec audit resource to test properties of a single AWS For additional information, including details on parameters and properties, see the [AWS documentation on SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-getting-started.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -60,7 +60,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -82,6 +84,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SNS:Client:GetTopicAttributesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="SNS:Client:GetTopicAttributesResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon SNS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonsns.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_topics.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_topics.md index cb84da18db..627b039e7d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_topics.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sns_topics.md @@ -16,9 +16,9 @@ User the 'aws_sns_topic' InSpec audit resource to test a single SNS Topic in an For additional information, including details on parameters and properties, see the [AWS documentation on SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-getting-started.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -75,6 +75,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SNS:Client:ListTopicsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="SNS:Client:ListTopicsResponse" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon SNS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonsns.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sqs_queue.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sqs_queue.md index 236d109c4b..ed1182cb07 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sqs_queue.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sqs_queue.md @@ -14,9 +14,9 @@ Use the `aws_sqs_queue` InSpec audit resource to test properties of a single AWS For additional information, including details on parameters and properties, see the [AWS documentation on SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/welcome.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -26,7 +26,6 @@ describe aws_sqs_queue(queue_url: 'https://sqs.ap-southeast-2.amazonaws.com/1212 end ``` - ## Parameters `queue_url` _(required)_ @@ -69,6 +68,12 @@ end `kms_data_key_reuse_period_seconds` : Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. +`sqs_managed_enabled` +: Returns information about whether the queue is using SSE-SQS encryption using SQS-owned encryption keys. + +`policy` +: Returns the policy of the queue. + ## Examples **Ensure that a queue exists and has a visibility timeout of 300 seconds.** @@ -116,13 +121,15 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist The control will pass if the describe returns at least one result. -Use `should_not` to test the entity should not exist. +Use `should` to test the entity should exist. ```ruby describe aws_sqs_queue('https://sqs.ap-southeast-2.amazonaws.com/1212121/MyQueue') do @@ -130,13 +137,51 @@ describe aws_sqs_queue('https://sqs.ap-southeast-2.amazonaws.com/1212121/MyQueue end ``` +Use `should_not` to test the entity should not exist. + ```ruby describe aws_sqs_queue('https://sqs.ap-southeast-2.amazonaws.com/1212121/MyQueueWhichDoesntExist') do it { should_not exist } end ``` +### policy_statement_principal_all_permissions_enabled + +The control will pass if at least one Principal has all permissions enabled. + +Use `should` to test when a Principal with all permissions should exist. + +```ruby +describe aws_sqs_queue('https://sqs.ap-southeast-2.amazonaws.com/1212121/MyQueue') do + it { should be_policy_statement_principal_all_permissions_enabled } +end +``` + +Use `should_not` to test that a Principal with all permissions should not exist. + +```ruby +describe aws_sqs_queue('https://sqs.ap-southeast-2.amazonaws.com/1212121/MyQueueWhichDoesntExist') do + it { should_not be_policy_statement_principal_all_permissions_enabled } +end +``` + +### policy_statement_action_all_permissions_enabled + +The control will pass if at least one action has all permissions enabled. + +Use `should` to test that at least one action has all permissions enabled should exist. + +```ruby +describe aws_sqs_queue('https://sqs.ap-southeast-2.amazonaws.com/1212121/MyQueue') do + it { should be_policy_statement_action_all_permissions_enabled } +end +```ruby +describe aws_sqs_queue('https://sqs.ap-southeast-2.amazonaws.com/1212121/MyQueueWhichDoesntExist') do + it { should_not be_policy_statement_action_all_permissions_enabled } +end +``` + ## AWS Permissions -{{% aws_permissions_principal action="SQS:Client:GetQueueAttributesResult" %}} +{{% inspec-aws/aws_permissions_principal action="SQS:Client:GetQueueAttributesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-using-identity-based-policies.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sqs_queues.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sqs_queues.md index 559220278e..2377e00b4c 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sqs_queues.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sqs_queues.md @@ -14,9 +14,9 @@ Use the `aws_sqs_queues` InSpec audit resource to test properties of some or al For additional information, including details on parameters and properties, see the [AWS documentation on SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/welcome.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -70,7 +70,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -92,5 +94,5 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SQS:Client:GetQueueAttributesResult" %}} +{{% inspec-aws/aws_permissions_principal action="SQS:Client:GetQueueAttributesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-using-identity-based-policies.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_activation.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_activation.md index 81f2821405..058e08701e 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_activation.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_activation.md @@ -14,9 +14,9 @@ Use the `aws_ssm_activation` InSpec audit resource to test properties of a ssm a For additional information, including details on parameters and properties, see the [AWS documentation on SSM Activations](https://docs.aws.amazon.com/systems-manager/latest/userguide/activations.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -81,7 +81,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -103,6 +105,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:DescribeActivationsResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:DescribeActivationsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Systems Manager](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awssystemsmanager.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_activations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_activations.md index ffc91d0a24..d7b460d17d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_activations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_activations.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ssm_activations` InSpec audit resource to test properties of a collection of AWS SSM Activations. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,7 +76,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -98,6 +100,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:DescribeActivationsResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:DescribeActivationsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Systems Manager](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awssystemsmanager.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_association.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_association.md index f4324f63e9..79bff2e949 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_association.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_association.md @@ -14,9 +14,9 @@ Use the `aws_ssm_association` InSpec audit resource to test properties of a ssm For additional information, including details on parameters and properties, see the [AWS documentation on SSM Associations](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -123,7 +123,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -145,6 +147,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:DescribeAssociationResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:DescribeAssociationResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Systems Manager](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awssystemsmanager.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_associations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_associations.md index 56889b27a8..fa665575ca 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_associations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_associations.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ssm_associations` InSpec audit resource to test properties of a collection of AWS SSM Associations. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,7 +76,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -98,6 +100,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:ListAssociationsResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:ListAssociationsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Systems Manager](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awssystemsmanager.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_document.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_document.md index 5f07e41d9c..0d5a5ae9aa 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_document.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_document.md @@ -14,9 +14,9 @@ Use the `aws_ssm_document` InSpec audit resource to test properties of a ssm doc For additional information, including details on parameters and properties, see the [AWS documentation on SSM Documents](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -119,7 +119,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -141,6 +143,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:DescribeDocumentResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:DescribeDocumentResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Systems Manager](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awssystemsmanager.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_documents.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_documents.md index 106a854a0e..452606e0e4 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_documents.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_documents.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ssm_documents` InSpec audit resource to test properties of a collection of AWS SSM Compliance Items. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -73,7 +73,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -95,6 +97,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:ListDocumentsResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:ListDocumentsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Systems Manager](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awssystemsmanager.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window.md index b35c477df2..b91e53b276 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window.md @@ -16,9 +16,9 @@ The `AWS::SSM::MaintenanceWindow` resource represents general information about For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::SSM::MaintenanceWindow` resource type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -119,9 +119,11 @@ end ## Matchers -This Chef InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +This Chef InSpec audit resource has the following special matchers. -The controls will pass if the `get` method returns at least one result. +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -153,4 +155,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:GetMaintenanceWindowResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:GetMaintenanceWindowResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_target.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_target.md index 9b7af0b6f2..92455942d8 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_target.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_target.md @@ -14,9 +14,9 @@ Use the `aws_ssm_maintenance_window_target` Chef InSpec audit resource to test p For additional information, including details on parameters and properties, see the [AWS documentation on AWS SSM MaintenanceWindowTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -95,7 +95,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -129,4 +129,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:DescribeMaintenanceWindowTargetsResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:DescribeMaintenanceWindowTargetsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_targets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_targets.md index e4c2df4a24..88e0f7d3c1 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_targets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_targets.md @@ -14,9 +14,9 @@ Use the `aws_ssm_maintenance_window_targets` InSpec audit resource to test prope For additional information, including details on parameters and properties, see the [AWS documentation on AWS SSM MaintenanceWindowTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -99,7 +99,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -133,4 +133,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:DescribeMaintenanceWindowTargetsResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:DescribeMaintenanceWindowTargetsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_task.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_task.md index 86b89b4111..3a1099d539 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_task.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_task.md @@ -16,9 +16,9 @@ The `AWS::SSM::MaintenanceWindowTask` resource defines information about a task For additional information, including details on parameters and properties, see the [AWS documentation on AWS SSM MaintenanceWindowTask](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -132,7 +132,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -156,4 +156,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:DescribeMaintenanceWindowTasksResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:DescribeMaintenanceWindowTasksResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_tasks.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_tasks.md index aef3da2ac4..f09aa168d9 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_tasks.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_window_tasks.md @@ -16,9 +16,9 @@ The `AWS::SSM::MaintenanceWindowTask` resource defines information about a task For additional information, including details on parameters and properties, see the [AWS documentation on AWS SSM MaintenanceWindowTask](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -144,7 +144,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -168,4 +168,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:DescribeMaintenanceWindowTasksResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:DescribeMaintenanceWindowTasksResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_windows.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_windows.md index fbeb1692f8..e2f9696ff4 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_windows.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_maintenance_windows.md @@ -16,9 +16,9 @@ The `AWS::SSM::MaintenanceWindow` resource represents general information about For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::SSM::MaintenanceWindow` resource type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -124,7 +124,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -148,4 +148,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:DescribeMaintenanceWindowsResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:DescribeMaintenanceWindowsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_parameter.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_parameter.md index 671c2c729e..f107c9db44 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_parameter.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_parameter.md @@ -14,9 +14,9 @@ Use the `aws_ssm_parameter` InSpec audit resource to test properties of a ssm pa For additional information, including details on parameters and properties, see the [AWS documentation on SSM Parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/integration-ps-secretsmanager.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -83,7 +83,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -105,6 +107,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:GetParameterResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:GetParameterResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Systems Manager](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awssystemsmanager.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_parameters.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_parameters.md index f34bea5301..2c7b799b29 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_parameters.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_parameters.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ssm_parameters` InSpec audit resource to test properties of a collection of AWS SSM parameters. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -70,7 +70,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -92,6 +94,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:DescribeParametersResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:DescribeParametersResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Systems Manager](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awssystemsmanager.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_patch_baseline.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_patch_baseline.md index 993580a48f..285e58eb70 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_patch_baseline.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_patch_baseline.md @@ -16,9 +16,9 @@ The `AWS::SSM::PatchBaseline` resource defines the basic information for an AWS For additional information, including details on parameters and properties, see the [AWS documentation on AWS SSM patch baseline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -209,9 +209,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -243,4 +243,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:GetPatchBaselineResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:GetPatchBaselineResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_patch_baselines.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_patch_baselines.md index a10bb12198..14e31f2e5f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_patch_baselines.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_patch_baselines.md @@ -16,9 +16,9 @@ The `AWS::SSM::PatchBaseline` resource defines the basic information for an AWS For additional information, including details on parameters and properties, see the [AWS documentation on AWS SSM patch baseline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -97,7 +97,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -131,4 +131,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:DescribePatchBaselinesResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:DescribePatchBaselinesResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_resource_compliance_summaries.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_resource_compliance_summaries.md index 418ecfa4f0..049b4f2a39 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_resource_compliance_summaries.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_resource_compliance_summaries.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ssm_resource_compliance_summaries` InSpec audit resource to test properties of a collection of AWS SSM compliance summaries. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -36,7 +36,7 @@ end : This optional parameter allows you to filter based on overall severity. This must be passed as a string `overall_severity: 'value'`. -See also the [AWS documentation on SSM](https://docs.aws.amazon.com/systems-manager/?id=docs_gateway). +See the [AWS documentation on SSM](https://docs.aws.amazon.com/systems-manager/?id=docs_gateway). ## Properties @@ -78,7 +78,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -100,6 +102,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:ListResourceComplianceSummariesResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:ListResourceComplianceSummariesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Systems Manager](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awssystemsmanager.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_resource_compliance_summary.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_resource_compliance_summary.md index cb31ffaf72..b8188a95bf 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_resource_compliance_summary.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_resource_compliance_summary.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_ssm_resource_compliance_summary` InSpec audit resource to test properties of a ssm resource compliance summary. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -46,7 +46,7 @@ end : This optional parameter allows you to filter based on resource_id and status together. This must be passed as a string `status: 'value'`. -See also the [AWS documentation on SSM Resource Compliance Summary](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-compliance-about.html#compliance-view-results). +See the [AWS documentation on SSM Resource Compliance Summary](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-compliance-about.html#compliance-view-results). ## Properties @@ -101,7 +101,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -123,6 +125,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:ListResourceComplianceSummariesResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:ListResourceComplianceSummariesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon Systems Manager](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awssystemsmanager.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_resource_data_syncs.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_resource_data_syncs.md index bda86c7b06..b7f8a88244 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_resource_data_syncs.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_ssm_resource_data_syncs.md @@ -16,9 +16,9 @@ The `AWS::SSM::ResourceDataSync` resource creates, updates, or deletes a resourc For additional information, including details on parameters and properties, see the [AWS documentation on AWS SSM ResourceDataSync](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -114,7 +114,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -138,4 +138,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="SSM:Client:ListResourceDataSyncResult" %}} +{{% inspec-aws/aws_permissions_principal action="SSM:Client:ListResourceDataSyncResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_activities.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_activities.md index aab9816d12..346ba8c00a 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_activities.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_activities.md @@ -14,9 +14,9 @@ Use the `aws_stepfunctions_activity` Chef InSpec audit resource to test properti For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::StepFunctions::Activity` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -69,7 +69,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -93,4 +93,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="States:Client:ListActivitiesOutput" %}} +{{% inspec-aws/aws_permissions_principal action="States:Client:ListActivitiesOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_activity.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_activity.md index 1605c24797..6d04d75f95 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_activity.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_activity.md @@ -14,9 +14,9 @@ Use the `aws_stepfunctions_activity` Chef InSpec audit resource to test properti For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::StepFunctions::Activity` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -65,7 +65,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -89,4 +89,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="States:Client:DescribeActivityOutput" %}} +{{% inspec-aws/aws_permissions_principal action="States:Client:DescribeActivityOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_state_machine.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_state_machine.md index 5bf64ca7c0..caf89a4ed8 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_state_machine.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_state_machine.md @@ -16,9 +16,9 @@ A state machine consists of a collection of states that can do work (Task states For additional information, including details on parameters and properties, see the [AWS documentation on Step Functions state machine](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -91,7 +91,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -124,4 +124,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="States:Client:DescribeStateMachineOutput" %}} +{{% inspec-aws/aws_permissions_principal action="States:Client:DescribeStateMachineOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_state_machines.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_state_machines.md index 476bd5bfae..a842eb5307 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_state_machines.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_stepfunctions_state_machines.md @@ -16,9 +16,9 @@ A state machine consists of a collection of states that can do work (Task states For additional information, including details on parameters and properties, see the [AWS documentation on Step Functions state machine](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -68,7 +68,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -102,4 +102,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="States:Client:ListStateMachinesOutput" %}} +{{% inspec-aws/aws_permissions_principal action="States:Client:ListStateMachinesOutput" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sts_caller_identity.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sts_caller_identity.md index 4e5c61b354..42c97166a8 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sts_caller_identity.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_sts_caller_identity.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_sts_caller_identity` InSpec audit resource to test properties of AWS IAM identity whose credentials are used in the current InSpec scan. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -80,7 +80,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### be_govcloud @@ -94,4 +96,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="STS:Client:GetCallerIdentityResponse" %}} +{{% inspec-aws/aws_permissions_principal action="STS:Client:GetCallerIdentityResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_subnet.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_subnet.md index c8e9263a57..f4c557704d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_subnet.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_subnet.md @@ -14,9 +14,9 @@ Use the `aws_subnet` InSpec audit resource to test properties of a vpc subnet. For additional information, including details on parameters and properties, see the [AWS documentation on Subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -88,7 +88,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. #### assigning_ipv_6_address_on_creation @@ -142,6 +144,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeSubnetsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeSubnetsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_subnets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_subnets.md index 54c82f40c9..a6c544f507 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_subnets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_subnets.md @@ -18,9 +18,9 @@ Separating IP addresses allows for protection if there is a failure in one avail For additional information, including details on parameters and properties, see the [AWS documentation on Subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -109,7 +109,7 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +For a full list of available matchers, visit the [InSpec matchers page](https://www.inspec.io/docs/reference/matchers/). ### exist @@ -131,6 +131,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeSubnetsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeSubnetsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_synthetics_canaries.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_synthetics_canaries.md index a50b740e90..0fd8b14f39 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_synthetics_canaries.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_synthetics_canaries.md @@ -14,9 +14,9 @@ Use the `aws_synthetics_canaries` Chef InSpec audit resource to test properties For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::Synthetics::Canary` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -139,7 +139,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -163,4 +163,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Synthetics:Client:DescribeCanariesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Synthetics:Client:DescribeCanariesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_synthetics_canary.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_synthetics_canary.md index acf4ad182a..15e47db374 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_synthetics_canary.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_synthetics_canary.md @@ -14,9 +14,9 @@ Use the `aws_synthetics_canary` Chef InSpec audit resource to test properties of For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::Synthetics::Canary` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -146,9 +146,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -170,4 +170,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Synthetics:Client:GetCanaryResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Synthetics:Client:GetCanaryResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transfer_user.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transfer_user.md index ec500ca205..42db1f0463 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transfer_user.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transfer_user.md @@ -14,9 +14,9 @@ Use the `aws_transfer_user` InSpec audit resource to test properties of a single For additional information, including details on parameters and properties, see the [AWS documentation on Transfer user](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -99,7 +99,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -133,4 +133,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Transfer:Client:DescribeUserResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Transfer:Client:DescribeUserResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transfer_users.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transfer_users.md index bce73c7120..258e19e20a 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transfer_users.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transfer_users.md @@ -14,9 +14,9 @@ Use the `aws_transfer_users` InSpec audit resource to test properties of multipl For additional information, including details on parameters and properties, see the [AWS documentation on Transfer user](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-user.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -72,7 +72,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -106,4 +106,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="Transfer:Client:ListUsersResponse" %}} +{{% inspec-aws/aws_permissions_principal action="Transfer:Client:ListUsersResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway.md index 38e8653cc9..bad18eebfe 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway.md @@ -14,9 +14,9 @@ Use the `aws_transit_gateway` InSpec audit resource to test properties of a tran For additional information, including details on parameters and properties, see the [AWS documentation on Transit Gateways](https://docs.aws.amazon.com/vpc/latest/tgw/). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -70,7 +70,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -84,6 +86,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeTransitGatewaysResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeTransitGatewaysResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_connect.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_connect.md index 36b3b2c6ed..ea892b88cf 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_connect.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_connect.md @@ -16,9 +16,9 @@ The `AWS::EC2::TransitGatewayConnect` resource creates a Connect attachment from For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 TransitGatewayConnect](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -79,7 +79,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -113,4 +113,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeTransitGatewayConnectsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeTransitGatewayConnectsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_connects.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_connects.md index cc753b29ce..305a6808b1 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_connects.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_connects.md @@ -16,9 +16,9 @@ The `AWS::EC2::TransitGatewayConnect` resource creates a Connect attachment from For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 TransitGatewayConnect](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -77,7 +77,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -111,4 +111,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeTransitGatewayConnectsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeTransitGatewayConnectsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domain.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domain.md index 04e436c994..cecc8a7ac3 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domain.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domain.md @@ -16,9 +16,9 @@ The `AWS::EC2::TransitGatewayMulticastDomain` resource creates a multicast domai For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 TransitGatewayConnect](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayconnect.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -88,7 +88,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -122,4 +122,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeTransitGatewayMulticastDomainsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeTransitGatewayMulticastDomainsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domain_association.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domain_association.md index 165a964ac3..3b5f53190d 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domain_association.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domain_association.md @@ -16,9 +16,9 @@ The `AWS::EC2::TransitGatewayMulticastDomainAssociation` resource associates the For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 TransitGatewayMulticastDomainAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,9 +76,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -110,4 +110,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:GetTransitGatewayMulticastDomainAssociationsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:GetTransitGatewayMulticastDomainAssociationsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domain_associations.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domain_associations.md index 994ea42dce..6e0a333fa4 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domain_associations.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domain_associations.md @@ -16,9 +16,9 @@ The `AWS::EC2::TransitGatewayMulticastDomainAssociation` resource associates the For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 TransitGatewayMulticastDomainAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomainassociation.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -73,9 +73,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -107,4 +107,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:GetTransitGatewayMulticastDomainAssociationsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:GetTransitGatewayMulticastDomainAssociationsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domains.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domains.md index 4d4b8e01aa..86144b3aeb 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domains.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_domains.md @@ -16,9 +16,9 @@ The `AWS::EC2::TransitGatewayMulticastDomain` resource creates a Connect attachm For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 TransitGatewayMulticastDomain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastdomain.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -80,7 +80,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `describe` method returns at least one result. @@ -114,4 +114,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeTransitGatewayMulticastDomainsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeTransitGatewayMulticastDomainsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_member.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_member.md index 747e3930b7..c8d926fb6f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_member.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_member.md @@ -16,9 +16,9 @@ The `AWS::EC2::TransitGatewayMulticastGroupMember` resource registers members (n For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 TransitGatewayMulticastGroupMember](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -91,7 +91,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `search` method returns at least one result. @@ -125,4 +125,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:SearchTransitGatewayMulticastGroupsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:SearchTransitGatewayMulticastGroupsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_members.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_members.md index aa7f160309..c0abf4dd23 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_members.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_members.md @@ -16,9 +16,9 @@ The `AWS::EC2::TransitGatewayMulticastGroupMember` resource registers members (n For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 TransitGatewayMulticastGroupMember](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupmember.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -113,7 +113,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `search` method returns at least one result. @@ -147,4 +147,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:SearchTransitGatewayMulticastGroupsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:SearchTransitGatewayMulticastGroupsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_source.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_source.md index 7c1194e4dd..4e04133ece 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_source.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_source.md @@ -16,9 +16,9 @@ The `AWS::EC2::TransitGatewayMulticastGroupSource` resource registers sources (n For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 TransitGatewayMulticastGroupSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -91,7 +91,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `search` method returns at least one result. @@ -125,4 +125,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:SearchTransitGatewayMulticastGroupsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:SearchTransitGatewayMulticastGroupsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_sources.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_sources.md index 85c654cdcb..94780bddcb 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_sources.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_multicast_group_sources.md @@ -16,9 +16,9 @@ The `AWS::EC2::TransitGatewayMulticastGroupSource` resource registers sources (n For additional information, including details on parameters and properties, see the [AWS documentation on AWS EC2 TransitGatewayMulticastGroupSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewaymulticastgroupsource.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -113,7 +113,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `search` method returns at least one result. @@ -147,4 +147,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:SearchTransitGatewayMulticastGroupsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:SearchTransitGatewayMulticastGroupsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_route.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_route.md index be27b849fa..090567cbb4 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_route.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_route.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_transit_gateway_route` InSpec audit resource to test the properties of a single AWS transit gateway route. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -171,6 +171,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeTransitGatewayRouteTablesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeTransitGatewayRouteTablesResult" %}} Get the detailed document at [Actions, Resources, and Condition Keys for transit gateway route](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-policy-examples.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_routes.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_routes.md index a364963cdc..0e91d92d2f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_routes.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_transit_gateway_routes.md @@ -13,9 +13,9 @@ parent = "inspec/resources/aws" Use the `aws_transit_gateway_routes` InSpec audit resource to test the properties of all Route for a AWS transit gateway route table. To audit a single gateway route, use the `aws_transit_gateway_route` (singular) resource. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -210,6 +210,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeTransitGatewayRouteTablesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeTransitGatewayRouteTablesResult" %}} Get the detailed document at [Actions, Resources, and Condition Keys for transit gateway route](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-policy-examples.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc.md index 0e9e97bf26..64d09f5995 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc.md @@ -18,9 +18,9 @@ Every AWS account has at least one VPC, the "default" VPC, in every region. For additional information, including details on parameters and properties, see the [AWS documentation on VPCs](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -299,6 +299,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpcsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpcsResult" %}} You can find the detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint.md index ce4906991a..a8c5c40265 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint.md @@ -16,9 +16,9 @@ A VPC Endpoint is uniquely identified by the VPC Endpoint ID (e.g vpce-123456abc For additional information, including details on parameters and properties, see the [AWS documentation on VPC Endpoints](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -147,7 +147,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the describe returns at least one result. @@ -220,6 +220,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpcEndpointsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpcEndpointsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_notification.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_notification.md index 2dbec05fbc..5801f21987 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_notification.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_notification.md @@ -14,9 +14,9 @@ Use the `aws_vpc_endpoint_connection_notification` Inspec audit resource to test For additional information, including details on parameters and properties, see the [AWS VPC endpoint connection notification documentation](https://docs.AWS.amazon.com/AWSCloudFormation/latest/UserGuide/AWS-resource-ec2-vpcendpointconnectionnotification.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -118,6 +118,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpcEndpointConnectionNotificationsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpcEndpointConnectionNotificationsResult" %}} You can find the detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.AWS.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). \ No newline at end of file diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_notifications.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_notifications.md index e7c1da1b7c..2051cbafd6 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_notifications.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_notifications.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_vpc_endpoint_connection_notifications` InSpec audit resource to test the properties of multiple AWS VPC endpoint connection notification. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -26,7 +26,7 @@ describe aws_vpc_endpoint_connection_notifications do end ``` -See also the [AWS VPC endpoint connection notification documentation](https://docs.AWS.amazon.com/AWSCloudFormation/latest/UserGuide/AWS-resource-ec2-vpcendpointconnectionnotification.html). +See the [AWS VPC endpoint connection notification documentation](https://docs.AWS.amazon.com/AWSCloudFormation/latest/UserGuide/AWS-resource-ec2-vpcendpointconnectionnotification.html). ## Parameters @@ -115,6 +115,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpcEndpointConnectionNotificationsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpcEndpointConnectionNotificationsResult" %}} You can find the detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.AWS.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_service.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_service.md index 6ee819e141..e7e9641817 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_service.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_service.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_vpc_endpoint_service` InSpec audit resource to test the properties of a single AWS VPC endpoint service. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -154,6 +154,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpcEndpointServicesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpcEndpointServicesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for VPC endpoint services](https://docs.amazonaws.cn/en_us/vpc/latest/userguide/vpc-policy-examples.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_service_permission.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_service_permission.md index 8957fbc93c..cf1f383437 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_service_permission.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_service_permission.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_vpc_endpoint_service_permission` InSpec audit resource to test the properties of a single AWS VPC endpoint service permission. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -67,8 +67,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} +This resource has the following special matchers. ### exist @@ -120,6 +121,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpcEndpointServicePermissionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpcEndpointServicePermissionsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon VPC endpoint service permissions](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcEndpointServicePermissions.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_service_permissions.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_service_permissions.md index 5eee2d4fe1..d64d13fd0f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_service_permissions.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_service_permissions.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_vpc_endpoint_service_permissions` InSpec audit resource to test the properties of all Amazon VPC endpoint service permissions. To audit a single AWS VPC Endpoint service, use the `aws_vpc_endpoint_service_permission` (singular) resource. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -77,7 +77,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -99,6 +101,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpcEndpointServicePermissionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpcEndpointServicePermissionsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon VPC endpoint service permissions](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcEndpointServicePermissions.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_services.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_services.md index 963d71d81e..b49d3c12fb 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_services.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoint_services.md @@ -13,9 +13,9 @@ parent = "inspec/resources/aws" Use the `aws_vpc_endpoint_services` InSpec audit resource to test the properties of all AWS VPC Endpoint Services. To audit a single endpoint service, use the `aws_vpc_endpoint_service` (singular) resource. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -165,6 +165,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpcEndpointServicesResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpcEndpointServicesResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for VPC endpoint services](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-policy-examples.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoints.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoints.md index 2cf4341412..6f495f8fcc 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoints.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpc_endpoints.md @@ -18,9 +18,9 @@ A Gateway type VPC endpoint accepts a route-table whereas an Interface type VPC For additional information, including details on parameters and properties, see the [AWS documentation on VPC Endpoints](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -96,7 +96,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -118,6 +120,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpcEndpointsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpcEndpointsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpcs.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpcs.md index 277bdc082a..fb9504286f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpcs.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpcs.md @@ -19,11 +19,11 @@ Every AWS account has at least one VPC, the "default" VPC, in every region. This resource also have the functionality to test the CIDR block. The VPCCidrBlock associates a CIDR block with your VPC. You can only associate a single IPv6 CIDR block with your VPC. The IPv6 CIDR block size is fixed at /56. For additional information, including details on parameters and properties, see the [AWS documentation on VPCs](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). -See also the [AWS documentation on VPCCidrBlock](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html). +See the [AWS documentation on VPCCidrBlock](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -255,6 +255,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpcsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpcsResult" %}} You can find detailed documentation at the [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_connection.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_connection.md new file mode 100644 index 0000000000..6d2ed4f8ee --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_connection.md @@ -0,0 +1,105 @@ ++++ +title = "aws_vpn_connection Resource" +platform = "aws" +draft = false +gh_repo = "inspec-aws" + +[menu.inspec] +title = "aws_vpn_connection" +identifier = "inspec/resources/aws/aws_vpn_connection Resource" +parent = "inspec/resources/aws" ++++ + +Use the `aws_vpn_connection` InSpec audit resource to test the properties of a single AWS VPN connection. + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} + +## Syntax + +An `aws_vpn_connection` resource block declares the tests for a single AWS VPN connection by `vpn_connection_id`. + +```ruby +describe aws_vpn_connection(vpn_connection_id: 'vpn-1234567890') do + it { should exist } +end +``` + +```ruby +describe aws_vpn_connection('vpn-1234567890') do + it { should exist } +end +``` + +## Parameters + +`vpn_connection_id` _(required)_ +: The identifier of the AWS VPN connection. It can be passed either as a string or as a `vpn_connection_id: 'value'` hash key-value entry. + +## Properties + +`vpn_connection_id` +: The identifier of the AWS VPN connection. + +`state` +: The current state of the VPN connection. Possible values are: `pending`, `available`, `deleting`, and `deleted`. + +`type` +: The type of VPN connection that the VPN connection supports. + +`vpn_gateway_id` +: The ID of the associated VPN. + +`tags` +: All tags that are associated with the VPN connection. + +There are also additional properties available. For a comprehensive list, see [the API reference documentation](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/Types/VpnConnection.html). + +## Examples + +### Test that a VPN connection is available + +```ruby +describe aws_vpn_connection('vpn-1234567890') do + its('vpn_connection_id') { should eq 'vpn-1234567890' } +end +``` + +### Test that a VPN connection status is available + +```ruby +describe aws_vpn_connection('vpn-1234567890') do + its('status') { should eq 'available' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +The control passes if the `get` method returns at least one result. + +### exist + +Use `should` to test that the entity exists. + +```ruby +describe aws_vpn_connection('vpn-1234567890') do + it { should exist } +end +``` + +### not exist + +Use `should_not` to test that the entity does not exist. + +```ruby +describe aws_vpn_connection('vpn-1234567890') do + it { should_not exist } +end +``` + +## AWS Permissions + +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpnConnectionsResult" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_connections.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_connections.md index 71db262933..8f36134bff 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_connections.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_connections.md @@ -10,17 +10,17 @@ identifier = "inspec/resources/aws/aws_vpn_connections Resource" parent = "inspec/resources/aws" +++ -Use the `aws_vpn_connections` InSpec audit resource to test properties of all AWS VPN Connections. +Use the `aws_vpn_connections` InSpec audit resource to test the properties of all AWS VPN connections. For additional information, including details on parameters and properties, see the [AWS documentation on VPN Connections](https://docs.aws.amazon.com/vpc/latest/userguide/vpn-connections.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax -Ensure that one or more VPN Connections exist. +Ensure that one or more VPN connections exist. ```ruby describe aws_vpn_connections do @@ -35,29 +35,29 @@ This resource does not require any parameters. ## Properties `vpn_connection_ids` -: This property provides all the IDs of the VPN Connections. +: This property provides all the IDs of the VPN connections. `vpn_gateway_ids` -: This property provides all the IDs of the virtual private gateways associated with the VPN Connections. +: This property provides all the IDs of the virtual private gateways associated with the VPN connections. `outside_ip_addresses` -: This property provides the outside IP addresses of the VPN Connections. +: This property provides the outside IP addresses of the VPN connections. `tunnel_inside_cidrs` -: This property provides the tunnel inside cidrs of the VPN Connections. +: This property provides the tunnel inside CIDRs of the VPN connections. `states` -: This property provides the current state of the VPN Connections. +: This property provides the current state of the VPN connections. `types` -: This property provides the current types of the VPN Connections. +: This property provides the current types of VPN connections. `tags` -: This property provids the current tags of the VPN Connections. +: This property provides the current tags of the VPN connections. ## Examples -**Ensure that VPN connections are available.** +### Ensure that VPN connections are available ```ruby describe aws_vpn_connections do @@ -65,7 +65,7 @@ describe aws_vpn_connections do end ``` -**Check tags .** +### To check tags ```ruby describe aws_vpn_connections.where { tags["Name"] == "vpn-connection-example-123" } do @@ -76,13 +76,13 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -### exist +This resource has the following special matchers. -The control will pass if the describe returns at least one result. +### exist -Use `should_not` to test the entity should not exist. +The control passes if the describe returns at least one result. ```ruby describe aws_vpn_connections do @@ -90,6 +90,10 @@ describe aws_vpn_connections do end ``` +### not exists + +Use `should_not` to test whether the entity should not exist. + ```ruby describe aws_vpn_connections do it { should_not exist } @@ -98,6 +102,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpnConnectionsResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpnConnectionsResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_gateway.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_gateway.md index a051acc174..d3ef430ccb 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_gateway.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_gateway.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_vpn_gateway` InSpec audit resource to test the properties of a single AWS VPN gateway. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -86,8 +86,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} +This resource has the following special matchers. ### exist @@ -108,6 +109,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpnGatewaysResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpnGatewaysResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon ElastiCache](https://docs.amazonaws.cn/en_us/vpc/latest/userguide/vpc-policy-examples.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_gateways.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_gateways.md index bdfc5afa84..54c4fbb612 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_gateways.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_vpn_gateways.md @@ -12,9 +12,9 @@ parent = "inspec/resources/aws" Use the `aws_vpn_gateways` InSpec audit resource to test the properties of all Amazon VPN gateways. To audit a single AWS VPN gateway, use the `aws_vpn_gateway` (singular) resource. -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -76,7 +76,9 @@ end ## Matchers -For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -98,6 +100,6 @@ end ## AWS Permissions -{{% aws_permissions_principal action="EC2:Client:DescribeVpnGatewaysResult" %}} +{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeVpnGatewaysResult" %}} You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon ElastiCache](https://docs.amazonaws.cn/en_us/vpc/latest/userguide/vpc-policy-examples.html), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_byte_match_set.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_byte_match_set.md index 6ffb43b315..2a0188df39 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_byte_match_set.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_byte_match_set.md @@ -14,9 +14,9 @@ Use the `aws_waf_byte_match_set` Chef InSpec audit resource to test the properti For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::WAF::ByteMatchSet` resource type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-bytematchset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -91,9 +91,11 @@ end ## Matchers -This Chef InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +This Chef InSpec audit resource has the following special matchers. -The controls will pass if the `get` method returns at least one result. +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -125,4 +127,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="WAF:Client:GetByteMatchSetResponse" %}} +{{% inspec-aws/aws_permissions_principal action="WAF:Client:GetByteMatchSetResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_byte_match_sets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_byte_match_sets.md index 5422c84d1c..75fc871772 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_byte_match_sets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_byte_match_sets.md @@ -14,9 +14,9 @@ Use the `aws_waf_byte_match_sets` Chef InSpec audit resource to test the propert For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::WAF::ByteMatchSet` resource type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-bytematchset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -64,7 +64,9 @@ end ## Matchers -This Chef InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +This Chef InSpec audit resource has the following special matchers. + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -88,4 +90,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="WAF:Client:ListByteMatchSetsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="WAF:Client:ListByteMatchSetsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_ip_set.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_ip_set.md index 33dabea986..7810636901 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_ip_set.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_ip_set.md @@ -14,9 +14,9 @@ Use the `aws_waf_ip_set` Chef InSpec audit resource to test the properties of a For additional information, including details on parameters and properties, see the [AWS documentation on AWS WAF IPSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-ipset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -79,9 +79,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -113,4 +113,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="WAF:Client:GetIPSetResponse" %}} +{{% inspec-aws/aws_permissions_principal action="WAF:Client:GetIPSetResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_ip_sets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_ip_sets.md index 165e925260..72aca4c6d6 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_ip_sets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_ip_sets.md @@ -14,9 +14,9 @@ Use the `aws_waf_ip_sets` Chef InSpec audit resource to test the properties of m For additional information, including details on parameters and properties, see the [AWS documentation on `AWS::WAF::IPSet` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-ipset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -66,7 +66,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -90,4 +90,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="WAF:Client:ListIPSetsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="WAF:Client:ListIPSetsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_rule.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_rule.md index cdfd3d77e9..0c4caa5706 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_rule.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_rule.md @@ -16,9 +16,9 @@ The `AWS::WAF::Rule` resource type creates a firewall rule that identifies the w For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::WAF::Rule` resource type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -92,9 +92,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -126,4 +126,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="WAF:Client:GetRuleResponse" %}} +{{% inspec-aws/aws_permissions_principal action="WAF:Client:GetRuleResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_rules.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_rules.md index 5a46aaba52..acf4fc3656 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_rules.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_rules.md @@ -14,9 +14,9 @@ Use the `aws_waf_rules` Chef InSpec audit resource to test the properties of mul For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::WAF::Rule` resource type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -64,7 +64,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -98,4 +98,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="WAF:Client:ListRulesResponse" %}} +{{% inspec-aws/aws_permissions_principal action="WAF:Client:ListRulesResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_size_constraint_set.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_size_constraint_set.md index 8f8cea0f1c..fe79fc12ff 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_size_constraint_set.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_size_constraint_set.md @@ -14,9 +14,9 @@ Use the `aws_waf_size_constraint_set` Chef InSpec audit resource to test the pro For additional information, including details on parameters and properties, see the [AWS documentation on `AWS::WAF::SizeConstraintSet` resource type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sizeconstraintset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -96,9 +96,11 @@ end ## Matchers -This Chef InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +This Chef InSpec audit resource has the following special matchers. -The controls will pass if the `get` method returns at least one result. +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist @@ -130,4 +132,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="WAF:Client:GetSizeConstraintSetResponse" %}} +{{% inspec-aws/aws_permissions_principal action="WAF:Client:GetSizeConstraintSetResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_size_constraint_sets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_size_constraint_sets.md index 05318de5b4..04009ce949 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_size_constraint_sets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_size_constraint_sets.md @@ -14,9 +14,9 @@ Use the `aws_waf_size_constraint_sets` Chef InSpec audit resource to test the pr For additional information, including details on parameters and properties, see the [AWS documentation on AWS WAF SizeConstraintSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sizeconstraintset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -64,7 +64,9 @@ end ## Matchers -This Chef InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +This Chef InSpec audit resource has the following special matchers. + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -88,4 +90,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="WAF:Client:ListSizeConstraintSetsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="WAF:Client:ListSizeConstraintSetsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_sql_injection_match_set.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_sql_injection_match_set.md index 640f29869d..10e04a79e8 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_sql_injection_match_set.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_sql_injection_match_set.md @@ -14,9 +14,9 @@ Use the `aws_waf_sql_injection_match_set` InSpec audit resource to test the prop For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::WAF::SqlInjectionMatchSet` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sqlinjectionmatchset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -82,9 +82,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -116,4 +116,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="WAF:Client:GetSqlInjectionMatchSetResponse" %}} +{{% inspec-aws/aws_permissions_principal action="WAF:Client:GetSqlInjectionMatchSetResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_sql_injection_match_sets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_sql_injection_match_sets.md index 88a973701e..f93388017a 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_sql_injection_match_sets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_sql_injection_match_sets.md @@ -14,9 +14,9 @@ Use the `aws_waf_sql_injection_match_sets` Chef InSpec audit resource to test th For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::WAF::SqlInjectionMatchSet` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sqlinjectionmatchset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -64,7 +64,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -98,4 +98,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="WAF:Client:ListSqlInjectionMatchSetsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="WAF:Client:ListSqlInjectionMatchSetsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_web_acl.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_web_acl.md index 599cfab046..09fe75cceb 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_web_acl.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_web_acl.md @@ -16,9 +16,9 @@ The `AWS::WAFv2::WebACL` AWS resource defines a collection of rules to use to in For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::WAFv2::WebACL` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -108,9 +108,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -142,4 +142,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="WAF:Client:GetWebACLResponse" %}} +{{% inspec-aws/aws_permissions_principal action="WAF:Client:GetWebACLResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_web_acls.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_web_acls.md index 03ec282772..237d4e783f 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_web_acls.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_web_acls.md @@ -16,9 +16,9 @@ The `AWS::WAFv2::WebACL` AWS resource defines a collection of rules to use to in For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::WAFv2::WebACL` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -66,7 +66,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -100,4 +100,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="WAF:Client:ListWebACLsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="WAF:Client:ListWebACLsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_xss_match_match_set.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_xss_match_match_set.md index 9fbad9e2e4..70dd6eabc6 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_xss_match_match_set.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_xss_match_match_set.md @@ -14,9 +14,9 @@ Use the `aws_waf_xss_match_set` InSpec audit resource to test the properties of For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::WAF::XssMatchSet` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-xssmatchset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -82,9 +82,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -The controls will pass if the `get` method returns at least one result. +This resource has the following special matchers. ### exist @@ -116,4 +116,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="WAF:Client:GetXssMatchSetResponse" %}} +{{% inspec-aws/aws_permissions_principal action="WAF:Client:GetXssMatchSetResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_xss_match_match_sets.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_xss_match_match_sets.md index 2278f7811e..a85a105469 100644 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_xss_match_match_sets.md +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/aws_waf_xss_match_match_sets.md @@ -14,9 +14,9 @@ Use the `aws_waf_xss_match_sets` InSpec audit resource to test the properties of For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::WAF::XssMatchSet` resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-xssmatchset.html). -## Installation +## Install -{{% inspec_aws_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}} ## Syntax @@ -64,7 +64,7 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} The controls will pass if the `list` method returns at least one result. @@ -88,4 +88,4 @@ end ## AWS Permissions -{{% aws_permissions_principal action="WAF:Client:ListXssMatchSetsResponse" %}} +{{% inspec-aws/aws_permissions_principal action="WAF:Client:ListXssMatchSetsResponse" %}} diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/reusable/index.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/reusable/index.md new file mode 100644 index 0000000000..41de90ae49 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/reusable/index.md @@ -0,0 +1,5 @@ ++++ +headless = true +## headless = true makes this directory a headless bundle. +## See https://gohugo.io/content-management/page-bundles/#headless-bundle ++++ diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/reusable/md/inspec_aws_install.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/reusable/md/inspec_aws_install.md new file mode 100644 index 0000000000..f935fd3fa3 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/content/inspec/resources/reusable/md/inspec_aws_install.md @@ -0,0 +1,4 @@ + +This resource is available in the [Chef InSpec AWS resource pack](https://github.com/inspec/inspec-aws). + +For information on configuring your AWS environment for Chef InSpec and creating an InSpec profile that uses the InSpec AWS resource pack, see the [Chef InSpec documentation on the AWS cloud platform](/inspec/cloud/aws/). diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/layouts/shortcodes/aws_permissions_principal.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/layouts/shortcodes/inspec-aws/aws_permissions_principal.md similarity index 100% rename from _vendor/github.com/inspec/inspec-aws/docs-chef-io/layouts/shortcodes/aws_permissions_principal.md rename to _vendor/github.com/inspec/inspec-aws/docs-chef-io/layouts/shortcodes/inspec-aws/aws_permissions_principal.md diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/layouts/shortcodes/inspec_aws_install.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/layouts/shortcodes/inspec_aws_install.md deleted file mode 100644 index 1c30bc95d0..0000000000 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/layouts/shortcodes/inspec_aws_install.md +++ /dev/null @@ -1,4 +0,0 @@ - -This resource is available in the [Chef InSpec AWS resource pack](https://github.com/inspec/inspec-aws). - -See the [Chef InSpec documentation on cloud platforms](/inspec/platforms/#aws-platform-support-in-inspec) for information on configuring your AWS environment for InSpec and creating an InSpec profile that uses the InSpec AWS resource pack. diff --git a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/layouts/shortcodes/inspec_filter_table.md b/_vendor/github.com/inspec/inspec-aws/docs-chef-io/layouts/shortcodes/inspec_filter_table.md deleted file mode 100644 index 92b235679d..0000000000 --- a/_vendor/github.com/inspec/inspec-aws/docs-chef-io/layouts/shortcodes/inspec_filter_table.md +++ /dev/null @@ -1,8 +0,0 @@ - -
-

Note

-
-

See the documentation on FilterTable for information on using filter criteria on plural resources. -

-
-
diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_domain_service.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_domain_service.md index 67cd2a171b..6044f771a2 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_domain_service.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_domain_service.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_active_directory_domain_service Resou parent = "inspec/resources/azure" +++ -Use the `azure_active_directory_domain_service` InSpec audit resource to test properties of an Azure Active Directory service within a tenant. +Use the `azure_active_directory_domain_service` InSpec audit resource to test the properties of an Azure Active Directory service within a tenant. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -40,10 +40,10 @@ Either one of the following parameters is mandatory. ## Properties `id` -: The fully qualified name of the domain. Key, immutable, not nullable, unique. +: The fully qualified name of the domain. Key, immutable, not nullable, and unique. `authenticationType` -: Indicates the configured authentication type for the domain.The value is either `Managed` or `Federated`. +: Indicates the configured authentication type for the domain. The value is either `Managed` or `Federated`. `availabilityStatus` : This property is always `null` except when the verify action is used. @@ -52,10 +52,10 @@ Either one of the following parameters is mandatory. : The value of the property is `false` if the DNS record management of the domain has been delegated to Microsoft 365. `isDefault` -: `true` if this is the default domain that is used for user creation. There is only one default domain per company. Not nullable. +: `true` if this is the default domain used for user creation. There is only one default domain per company. Not nullable. `isInitial` -: `true` if this is the initial domain created by Microsoft Online Services (companyname.onmicrosoft.com). There is only one initial domain per company. +: `true` if this is the initial domain created by Microsoft Online Services (`companyname.onmicrosoft.com`). There is only one initial domain per company. `isRoot` : `true` if the domain is a verified root domain. Otherwise, `false` if the domain is a subdomain or unverified. @@ -64,10 +64,10 @@ Either one of the following parameters is mandatory. : `true` if the domain has completed domain ownership verification. `passwordNotificationWindowInDays` -: Specifies the number of days before a user receives notification that their password will expire. If the property is not set, a default value of 14 days will be used. +: Specifies the number of days before a user receives notification that their password will expire. A default value of `14 days` will be used if the property is not set. `passwordValidityPeriodInDays` -: Specifies the length of time that a password is valid before it must be changed. If the property is not set, a default value of 90 days will be used. +: Specifies the length of time that a password is valid before it must be changed. A default value of `90 days` will be used if the property is not set. `supportedServices` : The capabilities assigned to the domain. @@ -77,7 +77,7 @@ Either one of the following parameters is mandatory. ## Examples -**Test If an Active Directory Domain is Referenced with a Valid ID.** +### Test if an active directory domain is referenced with a valid ID ```ruby describe azure_active_directory_domain_service(id: 'example.com') do @@ -85,7 +85,7 @@ describe azure_active_directory_domain_service(id: 'example.com') do end ``` -**Test If an Active Directory Domain is Referenced with an Invalid ID.** +### Test if an active directory domain is referenced with an invalid ID ```ruby describe azure_active_directory_domain_service(id: 'example.com') do @@ -95,7 +95,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists @@ -107,5 +109,4 @@ end ## Azure Permissions -Graph resources require specific privileges granted to your service principal. -Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. \ No newline at end of file +Graph resources require specific privileges granted to your service principal. Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_domain_services.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_domain_services.md index 7c3e3cc290..b0cc5c708c 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_domain_services.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_domain_services.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_active_directory_domain_services Reso parent = "inspec/resources/azure" +++ -Use the `azure_active_directory_domain_services` InSpec audit resource to test properties of some or all Azure Active Directory domains within a tenant. +Use the `azure_active_directory_domain_services` InSpec audit resource to test the properties of some or all Azure Active Directory domains within a tenant. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -35,12 +35,14 @@ end The following parameters can be passed for targeting specific domains. `filter` -: A hash containing the filtering options and their values. The `starts_with_` operator can be used for fuzzy string matching. Parameter names are in snake case. +: A hash containing the filtering options and their values. The `starts_with_` operator can be used for fuzzy string matching. Parameter names are in the snake case. : **Example**: `{ starts_with_given_name: 'J', starts_with_department: 'Core', country: 'United Kingdom', given_name: John}` `filter_free_text` -: [OData](https://www.odata.org/getting-started/basic-tutorial/) query string in double quotes, `"`. Property names are in camel case, refer to [Microsoft's query parameters documentation](https://docs.microsoft.com/en-us/graph/query-parameters#filter-parameter) for more information. +: [OData](https://www.odata.org/getting-started/basic-tutorial/) query string in double quotes, `"`. + +Property names are in camel case. For more information, refer to [Microsoft's query parameters documentation](https://docs.microsoft.com/en-us/graph/query-parameters#filter-parameter). : **Example**: `"startswith(displayName,'J') and surname eq 'Doe'"` or `"userType eq 'Guest'"` @@ -64,7 +66,7 @@ It is advised to use these parameters to narrow down the targeted resources at t : **Field**: `availabilityStatus` `is_admin_manageds` -: A list of admin managed configuration. +: A list of admin-managed configurations. : **Field**: `isAdminManaged` @@ -108,13 +110,17 @@ It is advised to use these parameters to narrow down the targeted resources at t : **Field**: `state` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples The following examples show how to use this InSpec audit resource. -**Check domains with some filtering parameters applied at server side using `filter`.** +### Check domains with some filtering parameters applied at the server side using 'filter' ```ruby describe azure_active_directory_domain_services(filter: {authenticationType: "authenticationType-value"}) do @@ -122,7 +128,7 @@ describe azure_active_directory_domain_services(filter: {authenticationType: "au end ``` -**Check domains with some filtering parameters applied at server side using `filter_free_text`.** +### Check domains with some filtering parameters applied at the server side using 'filter_free_text' ```ruby describe azure_active_directory_domain_services(filter_free_text: "startswith(authenticationType,'authenticationType-value')") do @@ -130,7 +136,7 @@ describe azure_active_directory_domain_services(filter_free_text: "startswith(au end ``` -**Ensure there are supported services using client-side filtering.** +### Test to ensure there are supported services using client-side filtering ```ruby describe azure_active_directory_domain_services.supportedServices do @@ -140,11 +146,13 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. ```ruby describe azure_active_directory_domain_services do @@ -154,5 +162,4 @@ end ## Azure Permissions -Graph resources require specific privileges granted to your service principal. -Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. +Graph resources require specific privileges granted to your service principal. Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_object.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_object.md index 139df9cebb..f43ed12c0e 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_object.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_object.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_active_directory_object Resource" parent = "inspec/resources/azure" +++ -Use the `azure_active_directory_object` InSpec audit resource to test properties of an Azure Active Directory object. +Use the `azure_active_directory_object` InSpec audit resource to test the properties of an Azure Active Directory object. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -30,7 +30,7 @@ end ## Parameters -parameter `id` is mandatory. +Parameter `id` is mandatory. `id` : The Active Directory object ID. @@ -67,16 +67,16 @@ parameter `id` is mandatory. : The group types of the AD object group. `isAssignableToRole` -: The roles assignable to AD object. +: The roles assignable to the AD object. `mail` -: The configured mail for AD object. +: The configured mail for the AD object. `mailEnabled` -: The mail enabled configuration parameter. +: The mail-enabled configuration parameter. `mailNickname` -: The mail nick name configuration. +: The mail nickname configuration. `membershipRule` : The membership rule for the AD object. @@ -85,16 +85,16 @@ parameter `id` is mandatory. : The processing state of the membership rule. `onPremisesDomainName` -: The domain name for the given on premises. +: The specified domain name for the on-premises domain. `onPremisesLastSyncDateTime` -: The on-premises latest sync datetime. +: The on-premises latest sync date time. `onPremisesNetBiosName` : The on-premises net bios name. `onPremisesSamAccountName` -: The on-premises sam account name. +: The on-premises SAM account name. `onPremisesSecurityIdentifier` : The on-premises security identifier. @@ -124,7 +124,7 @@ parameter `id` is mandatory. : The resource provisioning options set. `securityEnabled` -: The security enabled configured. +: The security-enabled configured. `securityIdentifier` : The security identifier configured. @@ -137,7 +137,7 @@ parameter `id` is mandatory. ## Examples -**Test if an Active Directory object is referenced with a valid ID.** +### Test if an Active Directory object is referenced with a valid ID ```ruby describe azure_active_directory_object(id: 'ACTIVE_DIRECTORY_OBJECT_ID') do @@ -145,7 +145,7 @@ describe azure_active_directory_object(id: 'ACTIVE_DIRECTORY_OBJECT_ID') do end ``` -**Test if an Active Directory object is referenced with an invalid ID.** +### Test if an Active Directory object is referenced with an invalid ID ```ruby describe azure_active_directory_object(id: 'ACTIVE_DIRECTORY_OBJECT_ID') do @@ -155,7 +155,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists @@ -167,5 +169,4 @@ end ## Azure Permissions -Graph resources require specific privileges granted to your service principal. -Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. \ No newline at end of file +Graph resources require specific privileges granted to your service principal. Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_objects.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_objects.md index 303c19de05..ed251f64ed 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_objects.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_active_directory_objects.md @@ -10,19 +10,20 @@ identifier = "inspec/resources/azure/azure_active_directory_objects Resource" parent = "inspec/resources/azure" +++ -Use the `azure_active_directory_objects` InSpec audit resource to test properties and configuration of multiple Azure Active Directory Objects. +Use the `azure_active_directory_objects` InSpec audit resource to test the properties and configuration of multiple Azure Active Directory objects. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_active_directory_objects` resource block returns all Active Directory Objects for the current service principle. +An `azure_active_directory_objects` resource block returns all Active Directory objects for the current service principle. + ```ruby describe azure_active_directory_objects do #... @@ -40,11 +41,15 @@ This resource does not require any parameters. : **Field**: `value` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Iterate over and test the visibility of Active Directory objects.** +### Iterate over and test the visibility of Active Directory objects ```ruby azure_active_directory_objects.values.each do |value| @@ -58,20 +63,26 @@ This resource does not require any parameters. ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. ```ruby -# If we expect current service principle to have AD objects +# If we expect the current service principle to have AD objects. describe azure_active_directory_objects do it { should exist } end +``` + +### not_exists -# If we expect current service principle to not have AD objects +```ruby +# If we expect the current service principle not to have AD objects. describe azure_active_directory_objects do it { should_not exist } @@ -80,4 +91,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_aks_cluster.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_aks_cluster.md index 2bd521324b..b915c07453 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_aks_cluster.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_aks_cluster.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_aks_cluster Resource" parent = "inspec/resources/azure" +++ -Use the `azure_aks_cluster` InSpec audit resource to test properties of an Azure AKS Cluster. +Use the `azure_aks_cluster` InSpec audit resource to test the properties of an Azure AKS Cluster. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_aks_cluster` resource block identifies an AKS Cluster by `name` and `resource_group` or the `resource_id`. +An `azure_aks_cluster` resource block identifies an AKS Cluster by `name` and `resource_group`, or the `resource_id`. + ```ruby -describe azure_aks_cluster(resource_group: 'example', name: 'ClusterName') do +describe azure_aks_cluster(resource_group: 'RESOURCE_GROUP', name: 'CLUSTER_NAME') do it { should exist } end ``` + ```ruby describe azure_aks_cluster(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ContainerService/managedClusters/{ClusterName}') do it { should exist } @@ -37,15 +39,16 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: Name of the AKS cluster to test. `ClusterName`. +: Name of the AKS cluster to test. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ContainerService/managedClusters/{ClusterName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` @@ -66,22 +69,21 @@ Either one of the parameter sets can be provided for a valid query: `disabled_logging_types` : The logging types that are disabled for the AKS cluster. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/aks/managedclusters/get#managedcluster) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/aks/managedclusters/get#managedcluster) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test that an AKS Cluster has the Desired Network Plug-in.** +### Test that an AKS Cluster has the desired network plug-in ```ruby -describe azure_aks_cluster(resource_group: 'example', name: 'ClusterName') do +describe azure_aks_cluster('RESOURCE_GROUP', name: 'CLUSTER_NAME') do its('properties.networkProfile.networkPlugin') { should cmp 'kubenet' } end ``` -**Loop through All Clusters within The Subscription.** +### Loop through all clusters within the subscription ```ruby azure_aks_clusters.ids.each do |resource_id| @@ -90,47 +92,57 @@ azure_aks_clusters.ids.each do |resource_id| end end ``` -**Test that a Specified AKS Cluster has the Correct Number of Nodes in Pool.** + +### Test that a specified AKS Cluster has the correct number of nodes in pool ```ruby -describe azure_aks_cluster(resource_group: 'example', name: 'ClusterName') do +describe azure_aks_cluster('RESOURCE_GROUP', name: 'CLUSTER_NAME') do its('properties.agentPoolProfiles.first.count') { should cmp 5 } end ``` -**Test that a Specified AKS Cluster has kube-audit logging enabled.** + +### Test that a specified AKS Cluster has kube-audit logging enabled ```ruby -describe azure_aks_cluster(resource_group: 'example', name: 'ClusterName') do +describe azure_aks_cluster('RESOURCE_GROUP', name: 'CLUSTER_NAME') do its('enabled_logging_types') { should include "kube-audit" } end ``` -**Test that a Specified AKS Cluster has logging enabled on it and no forms of logging disabled.** + +### Test that a specified AKS Cluster has logging enabled on it and no forms of logging are disabled ```ruby -describe azure_aks_cluster(resource_group: 'example', name: 'ClusterName') do +describe azure_aks_cluster('RESOURCE_GROUP', name: 'CLUSTER_NAME') do its('disabled_logging_types.count') { should eq 0 } end ``` -See [integration tests](../../test/integration/verify/controls/azurerm_aks_cluster.rb) for more examples. + +See [integration tests](https://github.com/inspec/inspec-azure/blob/main/test/integration/verify/controls/azure_aks_cluster.rb) for more examples. ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://docs.chef.io/inspec/matchers/). +This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit [Universal Matchers page](https://docs.chef.io/inspec/matchers/). ### exists ```ruby -# If we expect 'ClusterName' to always exist -describe azure_aks_cluster(resource_group: 'example', name: 'ClusterName') do +# If we expect 'CLUSTERNAME' to always exist. + +describe azure_aks_cluster('RESOURCE_GROUP', name: 'CLUSTER_NAME') do it { should exist } end +``` + +### not_exists + +```ruby +# If we expect 'CLUSTERNAME' to never exist. -# If we expect 'ClusterName' to never exist -describe azure_aks_cluster(resource_group: 'example', name: 'ClusterName') do +describe azure_aks_cluster('RESOURCE_GROUP', name: 'CLUSTER_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_aks_clusters.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_aks_clusters.md index ef64ec9820..48635be6e5 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_aks_clusters.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_aks_clusters.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_aks_clusters Resource" parent = "inspec/resources/azure" +++ -Use the `azure_aks_clusters` InSpec audit resource to test properties and configuration of multiple Azure AKS Clusters. +Use the `azure_aks_clusters` InSpec audit resource to test the properties and configuration of multiple Azure AKS Clusters. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_aks_clusters` resource block returns all AKS Clusters, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_aks_clusters` resource block returns all AKS Clusters, either within a Resource Group (if provided) or within an entire Subscription. + ```ruby describe azure_aks_clusters do #... end ``` -or + +Or + ```ruby -describe azure_aks_clusters(resource_group: 'my-rg') do +describe azure_aks_clusters(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -68,37 +71,50 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test that an Example Resource Group has the Named AKS Cluster.** +### Test that an example Resource Group has the named AKS Cluster ```ruby -describe azure_aks_clusters(resource_group: 'ExampleGroup') do +describe azure_aks_clusters(resource_group: 'RESOURCE_GROUP') do its('names') { should include('ClusterName') } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby -# If we expect 'ExampleGroup' Resource Group to have AKS Clusters -describe azure_aks_clusters(resource_group: 'ExampleGroup') do +# If we expect 'EXAMPLEGROUP' Resource Group to have AKS Clusters. + +describe azure_aks_clusters(resource_group: 'EXAMPLEGROUP') do it { should exist } end +``` + +### not_exists + +```ruby +# If we expect 'EMPTYEXAMPLEGROUP' Resource Group not to have AKS Clusters. -# If we expect 'EmptyExampleGroup' Resource Group to not have AKS Clusters -describe azure_aks_clusters(resource_group: 'EmptyExampleGroup') do +describe azure_aks_clusters(resource_group: 'EMPTYEXAMPLEGROUP') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_api_management.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_api_management.md index 4214d91f49..54838c1600 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_api_management.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_api_management.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_api_management Resource" parent = "inspec/resources/azure" +++ -Use the `azure_api_management` InSpec audit resource to test properties and configuration of an Azure API Management Service. +Use the `azure_api_management` InSpec audit resource to test the properties and configuration of an Azure API Management Service. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `name` or the `resource_id` must be given as a parameter. +`resource_group` and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_api_management(resource_group: 'inspec-resource-group-9', name: 'apim01') do +describe azure_api_management(resource_group: 'RESOURCE_GROUP', name: 'NAME') do it { should exist } end ``` + ```ruby describe azure_api_management(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ApiManagement/service/{apim01}') do it { should exist } @@ -37,18 +39,19 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: The unique name of the API Management Service. `apim01`. +: The unique name of the API Management Service. `api_management_name` : Alias for the `name` parameter. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ApiManagement/service/{apim01}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` - `resource_group` and `api_management_name` @@ -56,27 +59,26 @@ Either one of the parameter sets can be provided for a valid query: ## Properties `identity` -: Managed service identity of the Api Management service. It is an [api management service identity object](https://docs.microsoft.com/en-us/rest/api/apimanagement/2019-12-01/apimanagementservice/get#apimanagementserviceidentity). +: Managed service identity of the API Management service. It is an [API Management Service](https://docs.microsoft.com/en-us/rest/api/apimanagement/current-ga/api-management-service/get?tabs=HTTP#apimanagementservicegetservice). `sku` : The SKU (pricing tier) of the resource. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/apimanagement/2019-12-01/apimanagementservice/get#apimanagementserviceresource) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/apimanagement/current-ga/api-management-service/get?tabs=HTTP) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test API Management Service's Publisher Email Value.** +### Test API Management Service's publisher Email value ```ruby -describe azure_api_management(resource_group: resource_group, api_management_name: api_management_name) do +describe azure_api_management(resource_group: RESOURCE_GROUP, api_management_name: API_MANAGEMENT_NAME) do its('properties.publisherEmail') { should eq 'company@inspec.io' } end ``` -**Loop through Resources via Plural Resource.** +### Loop through resources via plural resource ```ruby azure_api_managements.ids.each do |resource_id| @@ -85,7 +87,8 @@ azure_api_managements.ids.each do |resource_id| end end ``` -See [integration tests](../../test/integration/verify/controls/azurerm_api_management.rb) for more examples. + +See [integration tests](https://github.com/inspec/inspec-azure/blob/main/test/integration/verify/controls/azure_api_management.rb) for more examples. ## Matchers @@ -94,18 +97,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect 'apim01' to always exist -describe azure_api_management(resource_group: 'example', name: 'apim01') do +# If we expect 'APIM01' always to exist. + +describe azure_api_management(resource_group: 'RESOURCE_GROUP', name: 'APIM01') do it { should exist } end +``` + +### not_exists -# If we expect 'apim01' to never exist -describe azure_api_management(resource_group: 'example', name: 'apim01') do +```ruby +# If we expect 'APIM01' to never exist. + +describe azure_api_management(resource_group: 'RESOURCE_GROUP', name: 'APIM01') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} - +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_api_managements.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_api_managements.md index 1bbf6f4615..64056c641c 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_api_managements.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_api_managements.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_api_managements Resource" parent = "inspec/resources/azure" +++ -Use the `azure_api_managements` InSpec audit resource to test properties and configuration of Azure API Management Services. +Use the `azure_api_managements` InSpec audit resource to test the properties and configuration of Azure API Management Services. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_api_managements` resource block returns all Azure Api Management Services, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_api_managements` resource block returns all Azure API Management Services, either within a Resource Group (if provided) or an entire Subscription. + ```ruby describe azure_api_managements do #... end ``` -or + +Or + ```ruby -describe azure_api_managements(resource_group: 'my-rg') do +describe azure_api_managements(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -73,11 +76,15 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check Api Management Services are Present.** +### Check API Management Services are present ```ruby describe azure_api_managements do @@ -85,7 +92,8 @@ describe azure_api_managements do its('names') { should include 'my-apim' } end ``` -**Filter the Results to Include Only those with Names Match the Given String Value.** + +### Filter the results to include only those with names that match the specified string value ```ruby describe azure_api_managements.where{ name.eql?('production-apim-01') } do @@ -95,24 +103,32 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby -# If we expect 'ExampleGroup' Resource Group to have API Management Services -describe azure_api_managements(resource_group: 'ExampleGroup') do +# If we expect 'EXAMPLEGROUP' Resource Group to have API Management Services. + +describe azure_api_managements(resource_group: 'EXAMPLEGROUP') do it { should exist } end +``` + +### not_exists -# If we expect 'EmptyExampleGroup' Resource Group to not have API Management Services -describe azure_api_managements(resource_group: 'EmptyExampleGroup') do +```ruby +# If we expect 'EMPTYEXAMPLEGROUP' Resource Group not to have API Management Services. + +describe azure_api_managements(resource_group: 'EMPTYEXAMPLEGROUP') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} - +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_application_gateway.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_application_gateway.md index d3eb372444..0d70521662 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_application_gateway.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_application_gateway.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_application_gateway Resource" parent = "inspec/resources/azure" +++ -Use the `azure_application_gateway` InSpec audit resource to test properties and configuration of an Azure Application Gateway. +Use the `azure_application_gateway` InSpec audit resource to test the properties and configuration of an Azure Application Gateway. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `name` or the `resource_id` must be given as a parameter. +`resource_group` and `name`, or the `resource_id` must be given as a parameter. + ```ruby -describe azure_application_gateway(resource_group: 'inspec-resource-group-9', name: 'example_lb') do +describe azure_application_gateway(resource_group: 'RESOURCE_GROUP', name: 'NAME') do it { should exist } end ``` + ```ruby describe azure_application_gateway(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/applicationGateways/{gatewayName}') do it { should exist } @@ -37,18 +39,19 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: The unique name of the targeted resource. `gatewayName`. +: The unique name of the targeted resource. `application_gateway_name` : Alias for the `name` parameter. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/applicationGateways/{gatewayName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` - `resource_group` and `application_gateway_name` @@ -59,29 +62,29 @@ Either one of the parameter sets can be provided for a valid query: : The identity of the application gateway, if configured. It is a [managed service identity object](https://docs.microsoft.com/en-us/rest/api/application-gateway/applicationgateways/get#managedserviceidentity). `zones` -: A list of availability zones denoting where the resource needs to come from. +: A list of availability zones denoting from where the resource needs to come. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/application-gateway/applicationgateways/get#applicationgateway) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/application-gateway/applicationgateways/get#applicationgateway) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test the SSL Policy Name of an Application Gateway.** +### Test the SSL policy name of an application gateway ```ruby -describe azure_application_gateway(resource_group: 'resource_group', application_gateway_name: 'application_gateway_name') do +describe azure_application_gateway(resource_group: 'RESOURCE_GROUP', application_gateway_name: 'APPLICATION_GATEWAY_NAME') do its('properties.sslPolicy.policyName') { should eq 'AppGwSslPolicy20170401S' } end ``` + ```ruby describe azure_application_gateway(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/applicationGateways/{gatewayName}') do its('properties.sslPolicy.policyName') { should eq 'AppGwSslPolicy20170401S' } end ``` -See [integration tests](../../test/integration/verify/controls/azurerm_application_gateway.rb) for more examples. +See [integration tests](https://github.com/inspec/inspec-azure/blob/main/test/integration/verify/controls/azure_application_gateway.rb) for more examples. ## Matchers @@ -90,17 +93,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect 'appgw-1' to always exist -describe azure_application_gateway(resource_group: 'example', name: 'appgw-1') do +# If we expect 'APPGW-1' always to exist. + +describe azure_application_gateway(resource_group: 'RESOURCE_GROUP', name: 'APPGW-1') do it { should exist } end +``` + +### not_exists + +```ruby +# If we expect 'APPGW-1' never to exist. -# If we expect 'appgw-1' to never exist -describe azure_application_gateway(resource_group: 'example', name: 'appgw-1') do +describe azure_application_gateway(resource_group: 'RESOURCE_GROUP', name: 'APPGW-1') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_application_gateways.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_application_gateways.md index 6798ab8ed6..c02e5a4ecf 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_application_gateways.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_application_gateways.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_application_gateways Resource" parent = "inspec/resources/azure" +++ -Use the `azure_application_gateways` InSpec audit resource to test properties and configuration of Azure Application Gateways. +Use the `azure_application_gateways` InSpec audit resource to test the properties and configuration of Azure Application Gateways. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_application_gateways` resource block returns all Azure Application Gateways, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_application_gateways` resource block returns all Azure Application Gateways, either within a Resource Group (if provided) or an entire Subscription. + ```ruby describe azure_application_gateways do #... end ``` -or + +Or + ```ruby -describe azure_application_gateways(resource_group: 'my-rg') do +describe azure_application_gateways(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -73,11 +76,15 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check Application Gateways are Present.** +### Check Application Gateways are present ```ruby describe azure_application_gateways do @@ -85,7 +92,8 @@ describe azure_application_gateways do its('names') { should include 'my-appgw' } end ``` -**Filter the Results to Include Only those with Names Match the Given String Value.** + +### Filter the results to include only those with names that match the specified string value ```ruby describe azure_application_gateways.where{ name.eql?('production-appgw-01') } do @@ -95,23 +103,33 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby -# If we expect 'ExampleGroup' Resource Group to have Application Gateways -describe azure_application_gateways(resource_group: 'ExampleGroup') do +# If we expect 'EXAMPLEGROUP' Resource Group to have Application Gateways. + +describe azure_application_gateways(resource_group: 'EXAMPLEGROUP') do it { should exist } end +``` + +### not_exists + +```ruby + +# If we expect 'EMPTYEXAMPLEGROUP' Resource Group not to have Application Gateways. -# If we expect 'EmptyExampleGroup' Resource Group to not have Application Gateways -describe azure_application_gateways(resource_group: 'EmptyExampleGroup') do +describe azure_application_gateways(resource_group: 'EMPTYEXAMPLEGROUP') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_bastion_hosts_resource.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_bastion_hosts_resource.md index ba2e29efa9..5e0aae8786 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_bastion_hosts_resource.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_bastion_hosts_resource.md @@ -10,21 +10,22 @@ identifier = "inspec/resources/azure/azure_bastion_hosts_resource Resource" parent = "inspec/resources/azure" +++ -Use the `azure_bastion_hosts_resource` InSpec audit resource to test properties related to a bastion hosts resource. +Use the `azure_bastion_hosts_resource` InSpec audit resource to test the properties related to a Bastion hosts resource. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and bastion hosts resource `name` or the `resource_id` must be given as a parameter. +`resource_group` and bastion hosts resource `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_bastion_hosts_resource(resource_group: 'MyResourceGroup', name: 'bastion_name') do +describe azure_bastion_hosts_resource(resource_group: 'RESOURCE_GROUP', name: 'NAME') do it { should exist } end ``` @@ -32,53 +33,51 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: Name of the virtual network to test. `MyVNetwork`. - -Both of the parameter sets should be provided for a valid query: -- `resource_group` and `name` +: Name of the virtual network to test. +Both the parameter sets should be provided for a valid query: `resource_group` and `name`. ## Properties `name` -: Name of the Azure resource to test. `MyBastionHostName`. +: Name of the Azure resource to test. `tags` : A list of `tag:value` pairs defined on the resources. `type` -: type of BastionHostName. +: type of Bastion hostname. `provisioning_state` -: State of BastionHostName creation. +: State of Bastion host name creation. -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/bastion-hosts/get) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/bastion-hosts/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Ensure that the bastion hosts resource has is from same type.** +### Test to ensure that the Bastion hosts resource is from the same type ```ruby -describe azure_bastion_hosts_resource(resource_group: 'MyResourceGroup', name: 'bastion_name') do +describe azure_bastion_hosts_resource(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('type') { should eq 'Microsoft.Network/bastionHosts' } end ``` -**Ensure that the bastion hosts resource is in successful state.** + +### Test to ensure that the Bastion hosts resource is in a successful state ```ruby -describe azure_bastion_hosts_resource(resource_group: 'MyResourceGroup', name: 'bastion_name') do +describe azure_bastion_hosts_resource(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('provisioning_state') { should include('Succeeded') } end ``` -**Ensure that the bastion hosts resource is from same location.** +### Test to ensure that the Bastion hosts resource is from the same location ```ruby -describe azure_bastion_hosts_resource(resource_group: 'MyResourceGroup', name: 'bastion_name') do +describe azure_bastion_hosts_resource(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('location') { should include df_location } end ``` @@ -90,18 +89,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a bastion hosts resource is found it will exist +# If a Bastion hosts resource is found, it will exist. -describe azure_bastion_hosts_resource(resource_group: 'MyResourceGroup', name: 'MyBastionHostName') do +describe azure_bastion_hosts_resource(resource_group: 'RESOURCE_GROUP', name: 'NAME') do it { should exist } end +``` + +### not_exists + +```ruby +# Bastion hosts resources that are not found, will not exist. -# bastion hosts resources that aren't found will not exist -describe azure_bastion_hosts_resource(resource_group: 'MyResourceGroup', name: 'DoesNotExist') do +describe azure_bastion_hosts_resource(resource_group: 'RESOURCE_GROUP', name: 'DOES_NOT_EXIST') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_bastion_hosts_resources.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_bastion_hosts_resources.md index f8a7ae952d..f97f172109 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_bastion_hosts_resources.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_bastion_hosts_resources.md @@ -10,22 +10,22 @@ identifier = "inspec/resources/azure/azure_bastion_hosts_resources Resource" parent = "inspec/resources/azure" +++ -Use the `azure_bastion_hosts_resources` InSpec audit resource to test properties of Azure Bastion hosts for a resource group or the entire subscription. +Use the `azure_bastion_hosts_resources` InSpec audit resource to test the properties of Azure Bastion hosts for a resource group or the entire subscription. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_bastion_hosts_resource` resource block returns all Azure Bastion hots, either within a Resource Group (if provided) +An `azure_bastion_hosts_resource` resource block returns all Azure Bastion hosts within a resource group (if provided). ```ruby -describe azure_bastion_hosts_resources(resource_group: 'my-rg') do +describe azure_bastion_hosts_resources(resource_group: 'RESOURCE_GROUP') do .. end ``` @@ -68,11 +68,15 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Ensure that the Bastion hosts resource has is from same type.** +### Test to ensure that the Bastion hosts resource is from the same type ```ruby describe azure_bastion_hosts_resources(resource_group: 'RESOURCE_GROUP') do @@ -80,7 +84,7 @@ describe azure_bastion_hosts_resources(resource_group: 'RESOURCE_GROUP') do end ``` -**Ensure that the Bastion hosts resource is in successful state.** +### Test to ensure that the Bastion hosts resource is in a successful state ```ruby describe azure_bastion_hosts_resources(resource_group: 'RESOURCE_GROUP') do @@ -88,7 +92,7 @@ describe azure_bastion_hosts_resources(resource_group: 'RESOURCE_GROUP') do end ``` -**Ensure that the Bastion hosts resource is from same location.** +### Test to ensure that the Bastion hosts resource is from the same location ```ruby describe azure_bastion_hosts_resources(resource_group: 'RESOURCE_GROUP') do @@ -96,7 +100,7 @@ describe azure_bastion_hosts_resources(resource_group: 'RESOURCE_GROUP') do end ``` -**Test if any Bastion hosts exist in the resource group.** +### Test if any Bastion hosts exist in the resource group ```ruby describe azure_bastion_hosts_resources(resource_group: 'RESOURCE_GROUP') do @@ -106,12 +110,14 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Bastion hots are in the resource group +# Should not exist if no Bastion hots are in the resource group. describe azure_bastion_hosts_resources(resource_group: 'RESOURCE_GROUP') do it { should_not exist } @@ -120,4 +126,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_blob_service.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_blob_service.md new file mode 100644 index 0000000000..65d7be7154 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_blob_service.md @@ -0,0 +1,130 @@ ++++ +title = "azure_blob_service Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_blob_service" +identifier = "inspec/resources/azure/azure_blob_service Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_blob_service` Chef InSpec audit resource to test the properties of an Azure Storage account’s Blob service. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_blob_service` resource block identifies an Azure Blob Service by `resource_group`, or the `storage_account_name`. + +```ruby +describe azure_blob_service(resource_group: 'RESOURCE_GROUP', storage_account_name: 'STORAGE_ACCOUNT_NAME') do + it { should exist } +end +``` + +## Parameters + +`resource_group` +: Azure resource group where the targeted resource resides. + +`storage_account_name` +: Name of the Storage account to test. + +## Properties + +`identity` +: The identity of the managed cluster, if configured. It is a [managed cluster identity object](https://docs.microsoft.com/en-us/rest/api/aks/managedclusters/get#managedclusteridentity). + +`id` +: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + +`name` +: The name of the resource + +`properties.automaticSnapshotPolicyEnabled` +: Deprecated in favor of isVersioningEnabled property. + +`properties.changeFeed` +: The blob service properties for change feed events. + +`properties.containerDeleteRetentionPolicy` +: The blob service properties for container soft delete. + +`properties.cors` +: Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service. + +`properties.defaultServiceVersion` +: DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions. + +`properties.deleteRetentionPolicy` +: The blob service properties for blob soft delete. + +`properties.isVersioningEnabled` +: Versioning is enabled if set to true. + +`properties.lastAccessTimeTrackingPolicy` +: The blob service property to configure last access time based tracking policy. + +`properties.restorePolicy` +: The blob service properties for blob restore policy. + +`sku` +: Sku name and tier. + +`type` +: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +See [Azure's documentation on Blob service](https://learn.microsoft.com/en-us/rest/api/storagerp/blob-services/get-service-properties?tabs=HTTP) for a full list of available properties. Any attribute in the response may be accessed with the key names separated by dots (`.`). + +## Examples + +### Test sku name in the Blob Service + +```ruby +describe azure_blob_service(resource_group: 'RESOURCE_GROUP', storage_account_name: 'STORAGE_ACCOUNT_NAME') do + its('sku.name') { should eq 'Standard_RAGRS' } +end +``` + +### Test that type + +```ruby +describe azure_blob_service(resource_group: 'RESOURCE_GROUP', storage_account_name: 'STORAGE_ACCOUNT_NAME') do + its('type') { should eq 'Microsoft.Storage/storageAccounts/blobServices' } +end +``` + +See [integration tests](https://github.com/inspec/inspec-azure/blob/main/test/integration/verify/controls/azure_blob_service.rb) for more examples. + +## Matchers + +This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit [Universal Matchers page](https://docs.chef.io/inspec/matchers/). + +### exists + +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + +```ruby +describe azure_blob_service(resource_group: 'RESOURCE_GROUP', storage_account_name: 'STORAGE_ACCOUNT_NAME') do + it { should exist } +end +``` + + +```ruby +describe azure_blob_service(resource_group: 'RESOURCE_GROUP', storage_account_name: 'STORAGE_ACCOUNT_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_blob_services.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_blob_services.md new file mode 100644 index 0000000000..2cf392763c --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_blob_services.md @@ -0,0 +1,112 @@ ++++ +title = "azure_blob_services Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_blob_services" +identifier = "inspec/resources/azure/azure_blob_services Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_blob_services` Chef InSpec audit resource to test the properties and configuration of multiple Azure storage accounts' Blob services. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_blob_services` resource block returns all Azure Blob Service, either within a Resource Group (if provided) or within an entire Subscription. + +```ruby +describe azure_blob_services(resource_group: 'RESOURCE_GROUP_NAME', storage_account_name: 'STORAGE_ACCOUNT_NAME') do + it { should exist } +end +``` + +## Parameters + +`resource_group` +: Azure resource group where the targeted resource resides. + +`storage_account_name` +: Name of the Storage account to test. + +## Properties + +`ids` +: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + +: **Field**: `id` + +`names` +: The name of the resource. + +: **Field**: `name` + +`properties` +: The property of the resource. + +: **Field**: `properties` + +`skus` +: Sku name and tier. + +: **Field**: `sku` + +`types` +: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +: **Field**: `type` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +See [Azure's documentation on Blob services](https://learn.microsoft.com/en-us/rest/api/storagerp/blob-services/list?tabs=HTTP) for a full list of available properties. + +## Examples + +### Test that an example Resource Group has the named storage account + +```ruby +describe azure_blob_services(resource_group: 'RESOURCE_GROUP_NAME', storage_account_name: 'STORAGE_ACCOUNT_NAME') do + its('names') { should include('STORAGE_ACCOUNT_NAME') } +end +``` + +See [integration tests](https://github.com/inspec/inspec-azure/blob/main/test/integration/verify/controls/azure_blob_services.rb) for more examples. + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exist + +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + +```ruby +describe azure_blob_services(resource_group: 'RESOURCE_GROUP_NAME', storage_account_name: 'STORAGE_ACCOUNT_NAME') do + it { should exist } +end +``` + +```ruby +describe azure_blob_services(resource_group: 'RESOURCE_GROUP_NAME', storage_account_name: 'STORAGE_ACCOUNT_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_cdn_profile.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_cdn_profile.md new file mode 100644 index 0000000000..492688d521 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_cdn_profile.md @@ -0,0 +1,109 @@ ++++ +title = "azure_cdn_profile Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_cdn_profile" +identifier = "inspec/resources/azure/azure_cdn_profile Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_cdn_profile` Chef InSpec audit resource to test the properties and configuration of an Azure CDN profile. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +Either the `resource_group` and `name`, or the `resource_id` are required . + +```ruby +describe azure_cdn_profile(resource_group: 'RESOURCE_GROUP', name: 'NAME') do + it { should exist } +end +``` + +```ruby +describe azure_cdn_profile(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}') do + it { should exist } +end +``` + +## Parameters + +`resource_group` +: Azure resource group that the targeted resource resides in. + +`name` +: The unique name of the CDN profile name. + +`resource_id` +: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}`. + +Provide one of the following parameter sets for a valid query: + +- `resource_id` +- `resource_group` and `name` + +## Properties + +`properties.frontDoorId` +: The ID of the frontdoor. + +For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +See the [Azure CDN profile documentation](https://docs.microsoft.com/en-us/rest/api/cdn/profiles/get#profile) for other available properties. +Any attribute in the response may be accessed with the key names separated by dots (`.`). + +## Examples + +**Check the resource state of a CDN profile.** + +```ruby +describe azure_cdn_profile(resource_group: 'RESOURCE_GROUP', name: 'NAME') do + its('properties.resourceState') { should eq 'Active' } +end +``` + +**Check the resource state of all profiles in a subscription.** + +```ruby +azure_cdn_profiles.ids.each do |id| + describe azure_cdn_profile(resource_id: id) do + its('properties.resourceState') { should eq 'Active' } + end +end +``` + +## Matchers + +This Chef InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://docs.chef.io/inspec/matchers/). + +### exists + +Use `exist` if a resource should exist. + +```ruby +describe azure_cdn_profile(resource_group: 'RESOURCE_GROUP', name: 'NAME') do + it { should exist } +end +``` + +Use `should_not` for a resource that should not exist. + +```ruby +describe azure_cdn_profile(resource_group: 'RESOURCE_GROUP', name: 'NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_cdn_profiles.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_cdn_profiles.md new file mode 100644 index 0000000000..6230de7a06 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_cdn_profiles.md @@ -0,0 +1,143 @@ ++++ +title = "azure_cdn_profiles Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_cdn_profiles" +identifier = "inspec/resources/azure/azure_cdn_profiles Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_cdn_profiles` Chef InSpec audit resource to test properties and configuration of Azure CDN profiles. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_cdn_profiles` resource block returns all Azure CDN profiles, either within a resource group (if provided), or within an entire subscription. + +```ruby +describe azure_cdn_profiles do + #... +end +``` + +or + +```ruby +describe azure_cdn_profiles(resource_group: 'RESOURCE_GROUP') do + #... +end +``` + +## Parameters + +`resource_group` _(optional)_ + +: The name of the resource group. + +## Properties + +`ids` +: A list of the unique resource ids. + +: **Field**: `id` + +`locations` +: A list of locations for all the resources being interrogated. + +: **Field**: `location` + +`names` +: A list of names of all the resources being interrogated. + +: **Field**: `name` + +`tags` +: A list of `tag:value` pairs defined on the resources being interrogated. + +: **Field**: `tags` + +`types` +: A list of the types of resources being interrogated. + +: **Field**: `type` + +`properties` +: A list of properties for all the resources being interrogated. + +: **Field**: `properties` + +`skus` +: A list of the SKUs of the resources being interrogated. + +: **Field**: `sku` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +**Check that a CDN profile is present.** + +````ruby +describe azure_cdn_profiles do + it { should exist } + its('names') { should include 'CDN_PROFILE' } +end +```` + +**Filter the CDN profiles by name and verify that it exists.** + +```ruby +describe azure_cdn_profiles.where{ name.eql?('CDN_PROFILE_NAME') } do + it { should exist } +end +``` + +**Filter the CDN profiles by location and verify that at least one exists.** + +```ruby +describe azure_cdn_profiles.where{ location.eql?('eastus-2') } do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +The control will pass if the filter returns at least one result. + +```ruby +describe azure_cdn_profiles(resource_group: 'RESOURCE_GROUP') do + it { should exist } +end +``` + +Use `should_not` if you expect zero matches. + +```ruby +describe azure_cdn_profiles(resource_group: 'RESOURCE_GROUP') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_group.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_group.md index c8038bd2d8..73b863db9c 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_group.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_group.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_container_group Resource" parent = "inspec/resources/azure" +++ -Use the `azure_container_group` InSpec audit resource to test properties related to an Azure container group. +Use the `azure_container_group` InSpec audit resource to test the properties related to an Azure container group. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`name` is a required parameter and `resource_group` could be provided as an optional parameter. +`name` is a required parameter, and `resource_group` could be provided as an optional parameter. ```ruby describe azure_container_group(resource_group: 'RESOURCE_GROUP_NAME', name: 'CONTAINER_GROUP_NAME') do @@ -45,10 +45,9 @@ end : Name of the Azure container group to test. `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. -The parameter set should be provided for a valid query: -- `resource_group` and `name` +The parameter sets that should be provided for a valid query are `resource_group` and `name`. ## Properties @@ -67,15 +66,13 @@ The parameter set should be provided for a valid query: `properties` : The properties of the resource. +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). - -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/container-instances/container-groups/get) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/container-instances/container-groups/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test that the container group has a public IP address.** +### Test that the container group has a public IP address ```ruby describe azure_container_group(resource_group: 'RESOURCE_GROUP_NAME', name: 'CONTAINER_GROUP_NAME') do @@ -90,13 +87,17 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a container group is found it will exist +# If a container group is found, it will exist. describe azure_container_group(resource_group: 'RESOURCE_GROUP_NAME', name: 'CONTAINER_GROUP_NAME') do it { should exist } end +``` -# container groups that aren't found will not exist +### not_exists + +```ruby +# container groups that are not found, will not exist. describe azure_container_group(resource_group: 'RESOURCE_GROUP_NAME', name: 'CONTAINER_GROUP_NAME') do it { should_not exist } end @@ -104,4 +105,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_groups.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_groups.md index 13a4150ca4..8851011e55 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_groups.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_groups.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_container_groups Resource" parent = "inspec/resources/azure" +++ -Use the `azure_container_groups` InSpec audit resource to test properties related to all Azure container groups within a subscription. +Use the `azure_container_groups` InSpec audit resource to test the properties related to all Azure container groups within a subscription. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -62,7 +62,7 @@ This resource does not require any parameters. : **Field**: `tags` `properties` -: A list of Properties all the resources. +: A list of properties all the resources. : **Field**: `properties` @@ -77,7 +77,7 @@ This resource does not require any parameters. : **Field**: `init_containers` `image_registry_credentials` -: A list of image registry credentials by which the container group is created from. +: A list of image registry credentials through which the container group is created. : **Field**: `image_registry_credentials` @@ -102,7 +102,7 @@ This resource does not require any parameters. : **Field**: `volumes` `skus` -: A list SKU for a container group. +: A list SKUs for a container group. : **Field**: `sku` @@ -111,11 +111,15 @@ This resource does not require any parameters. : **Field**: `restart_policy` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through container groups by their names.** +### Test to loop through container groups by their names ```ruby azure_container_groups.names.each do |name| @@ -125,7 +129,7 @@ azure_container_groups.names.each do |name| end ``` -**Test that there are container groups with valid name.** +### Test to ensure there are container groups with valid name ```ruby describe azure_container_groups.where(name: 'CONTAINER_GROUP_NAME') do @@ -135,18 +139,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no container groups are present in the subscription +# Should not exist if no container groups are present in the subscription. describe azure_container_groups do it { should_not exist } end +``` + +### not_exists -# Should exist if the filter returns at least one container group in the subscription +```ruby +# Should exist if the filter returns at least one container group in the subscription. describe azure_container_groups do it { should exist } @@ -155,4 +165,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_registries.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_registries.md index 32de2ade03..2a736f2372 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_registries.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_registries.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_container_registries Resource" parent = "inspec/resources/azure" +++ -Use the `azure_container_registries` InSpec audit resource to test properties and configuration of Azure Container Registries. +Use the `azure_container_registries` InSpec audit resource to test the properties and configuration of Azure Container Registries. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_container_registries` resource block returns all Azure Container Registries, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_container_registries` resource block returns all Azure Container Registries, within a Resource Group (if provided) or an entire Subscription. ```ruby describe azure_container_registries do @@ -33,7 +33,7 @@ end or ```ruby -describe azure_container_registries(resource_group: 'my-rg') do +describe azure_container_registries(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -76,11 +76,15 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check container registries are present.** +### Check container registries are present ```ruby describe azure_container_registries do @@ -89,7 +93,7 @@ describe azure_container_registries do end ``` -**Filter the results to include only those with names match the given string value.** +### Filter the results to include only those with names match the given string value ```ruby describe azure_container_registries.where{ name.eql?('production-cr-01') } do @@ -99,28 +103,34 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. +The control passes if the filter returns at least one result. ```ruby -# If we expect 'ExampleGroup' Resource Group to have Container Registries -describe azure_container_registries(resource_group: 'ExampleGroup') do +# If we expect 'EXAMPLEGROUP' resource group to have Container Registries. + +describe azure_container_registries(resource_group: 'EXAMPLEGROUP') do it { should exist } end ``` +### not_exists + Use `should_not` if you expect zero matches. ```ruby -# If we expect 'EmptyExampleGroup' Resource Group to not have Container Registries -describe azure_container_registries(resource_group: 'EmptyExampleGroup') do +# If we expect 'EMPTYEXAMPLEGROUP' resource group to not have Container Registries. + +describe azure_container_registries(resource_group: 'EMPTYEXAMPLEGROUP') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_registry.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_registry.md index 01dbc60e06..7055837abf 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_registry.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_container_registry.md @@ -10,22 +10,22 @@ identifier = "inspec/resources/azure/azure_container_registry Resource" parent = "inspec/resources/azure" +++ -Use the `azure_container_registry` InSpec audit resource to test properties and configuration of an Azure Container Registry. +Use the `azure_container_registry` InSpec audit resource to test the properties and configuration of an Azure Container Registry. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax This resource requires the `resource_group` and `name` parameters, or the `resource_id` parameter. ```ruby -describe azure_container_registry(resource_group: 'inspec-resource-group-9', name: 'example_cr') do +describe azure_container_registry(resource_group: 'RESOURCE_GROUP', name: 'NAME') do it { should exist } end ``` @@ -39,16 +39,16 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: The unique name of the targeted resource. `registryName`. +: The unique name of the targeted resource. `container_registry_name` : Alias for the `name` parameter. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ContainerRegistry/registries/{registryName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: @@ -64,18 +64,16 @@ Either one of the parameter sets can be provided for a valid query: `sku` : The SKU of the container registry. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to the [Azure documentation](https://docs.microsoft.com/en-us/rest/api/containerregistry/registries/get#registry) for other available properties. - -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to the [Azure documentation](https://docs.microsoft.com/en-us/rest/api/containerregistry/registries/get#registry) for other available properties. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test the status of the retention policy for container registry.** +### Test the status of the retention policy for the container registry ```ruby -describe azure_container_registry(resource_group: 'resource_group', name: 'container_registry_name') do +describe azure_container_registry(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('properties.status.retentionPolicy') { should cmp 'enabled' } end ``` @@ -86,7 +84,7 @@ describe azure_container_registry(resource_id: '/subscriptions/{subscriptionId}/ end ``` -See [integration tests](../../test/integration/verify/controls/azure_container_registry.rb) for more examples. +See [integration tests](https://github.com/inspec/inspec-azure/blob/main/test/integration/verify/controls/azure_container_registry.rb) for more examples. ## Matchers @@ -95,17 +93,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect 'cr-1' to always exist -describe azure_container_registry(resource_group: 'example', name: 'cr-1') do +# If we expect 'CR-1' to always exist. + +describe azure_container_registry(resource_group: 'RESOURCE_GROUP', name: 'CR-1') do it { should exist } end +``` + +### not_exists + +```ruby +# If we expect 'CR-1' to never exist. -# If we expect 'cr-1' to never exist -describe azure_container_registry(resource_group: 'example', name: 'cr-1') do +describe azure_container_registry(resource_group: 'RESOURCE_GROUP', name: 'CR-1') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_cosmosdb_database_account.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_cosmosdb_database_account.md index 75ba762ce7..65fd424286 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_cosmosdb_database_account.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_cosmosdb_database_account.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_cosmosdb_database_account Resource" parent = "inspec/resources/azure" +++ -Use the `azure_cosmosdb_database_account` InSpec audit resource to test properties and configuration of an Azure CosmosDb Database Account within a Resource Group. +Use the `azure_cosmosdb_database_account` InSpec audit resource to test the properties and configuration of an Azure CosmosDb Database account within a resource group. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `name` or the `resource_id` must be given as a parameter. +`resource_group` and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_cosmosdb_database_account(resource_group: 'inspec-resource-group-9', name: 'my-cosmos-db') do +describe azure_cosmosdb_database_account(resource_group: 'RESOURCE_GROUP', name: 'NAME') do it { should exist } end ``` + ```ruby describe azure_cosmosdb_database_account(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}') do it { should exist } @@ -37,18 +39,19 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `resource-group-name`. +: Azure resource group where the targeted resource resides. `name` -: The unique name of the targeted resource. `resource-name`. +: The unique name of the targeted resource. `cosmosdb_database_account` : Alias for the `name` parameter. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` - `resource_group` and `cosmosdb_database_account` @@ -56,25 +59,25 @@ Either one of the parameter sets can be provided for a valid query: ## Properties `location` -: Resource location, e.g. `eastus`. +: Resource location. For example, `eastus`. `kind` -: Indicates the type of database account, e.g. `GlobalDocumentDB`, `MongoDB`. +: Indicates the type of database account. For example, `GlobalDocumentDB`, `MongoDB`. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/cosmos-db-resource-provider/2020-04-01/databaseaccounts/get#databaseaccountgetresults) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/sql/2021-02-01-preview/databases/get?tabs=HTTP) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test If a GlobalDocumentDB is Accessible on Public Network.** +### Test if a GlobalDocumentDB is accessible on public network ```ruby -describe azure_cosmosdb_database_account(resource_group: 'my-rg', name: 'my-cosmos-db') do +describe azure_cosmosdb_database_account(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('properties.publicNetworkAccess') { should cmp 'Enabled' } end ``` + ```ruby describe azure_cosmosdb_database_account(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}') do its('properties.publicNetworkAccess') { should cmp 'Enabled' } @@ -88,17 +91,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect 'my-cosmos-db' to always exist -describe azure_cosmosdb_database_account(resource_group: 'example', name: 'appgw-1') do +# If we expect 'MY-COSMOS-DB' to always exist. + +describe azure_cosmosdb_database_account(resource_group: 'RESOURCE_GROUP', name: 'MY-COSMOS-DB) do it { should exist } end +``` + +### not_exists + +```ruby +# If we expect 'MY-COSMOS-DB' to never exist. -# If we expect 'my-cosmos-db' to never exist -describe azure_cosmosdb_database_account(resource_group: 'example', name: 'my-cosmos-db') do +describe azure_cosmosdb_database_account(resource_group: 'RESOURCE_GROUP', name: 'MY-COSMOS-DB') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factories.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factories.md index cf7e9182ec..5694f7dca4 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factories.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factories.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_data_factories Resource" parent = "inspec/resources/azure" +++ -Use the `azure_data_factories` InSpec audit resource to test properties related to data factories for a resource group or the entire subscription. +Use the `azure_data_factories` InSpec audit resource to test the properties related to data factories for a resource group or the entire subscription. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_data_factories` resource block returns all Azure data factories, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_data_factories` resource block returns all Azure data factories, either within a resource group (if provided) or within an entire Subscription. ```ruby describe azure_data_factories do @@ -33,7 +33,7 @@ end or ```ruby -describe azure_data_factories(resource_group: 'my-rg') do +describe azure_data_factories(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -41,7 +41,7 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. ## Properties @@ -51,7 +51,7 @@ end : **Field**: `name` `ids` -: A list of data factory IDs . +: A list of data factory IDs. : **Field**: `id` @@ -105,11 +105,15 @@ end : **Field**: `tenant_id` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test if any Data Factories exist in the resource group.** +### Test if any Data Factories exist in the resource group ```ruby describe azure_data_factories(resource_group: 'RESOURCE_GROUP') do @@ -117,17 +121,18 @@ describe azure_data_factories(resource_group: 'RESOURCE_GROUP') do its('names') { should include "factory_name" } end ``` -**Test that there aren't any Data Factories in a resource group.** + +### Test that there are not any Data Factories in a resource group ```ruby -**Should not exist if no Data Factory are in the resource group.** +# Should not exist if no Data Factory is in the resource group. describe azure_data_factories(resource_group: 'RESOURCE_GROUP') do it { should_not exist } end ``` -**Filter Data Factories in a resource group by properties.** +### Filter Data Factories in a resource group by properties ```ruby describe azure_data_factories(resource_group: 'RESOURCE_GROUP') do @@ -142,4 +147,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory.md index 5f5462a503..86d53d1e47 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory.md @@ -10,22 +10,22 @@ identifier = "inspec/resources/azure/azure_data_factory Resource" parent = "inspec/resources/azure" +++ -Use the `azure_data_factory` InSpec audit resource to test properties of an Azure data factory. +Use the `azure_data_factory` InSpec audit resource to test the properties of an Azure Data Factory. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and Data Factory `name` must be given as parameters. +`resource_group` and Data Factory `name` are required parameters. ```ruby -describe azure_data_factory(resource_group: resource_group, name: factory_name) do +describe azure_data_factory(resource_group: RESOURCE_GROUP, name: NAME) do it { should exist } its('name') { should eq factory_name } its('type') { should eq 'Microsoft.DataFactory/factories' } @@ -35,21 +35,20 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` : The factory name. -Both the parameter sets needs be provided for a valid query: -- `resource_group` and `name` +Both the parameter sets need to be provided for a valid query: `resource_group` and `name`. ## Properties `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group that the targeted resource resides in. `name` -: Name of the Azure resource to test. `MyDf`. +: Name of the Azure resource to test. `type` : The resource type. @@ -80,7 +79,7 @@ Both the parameter sets needs be provided for a valid query: ## Examples -**Test that a Data Factory exists.** +### Test that a Data Factory exists ```ruby describe azure_data_factory(resource_group: resource_group, name: 'DATA_FACTORY_NAME') do @@ -88,7 +87,7 @@ describe azure_data_factory(resource_group: resource_group, name: 'DATA_FACTORY_ end ``` -**Test that a Data Factory does not exist.** +### Test that a Data Factory does not exist ```ruby describe azure_data_factory(resource_group: resource_group, name: 'DATA_FACTORY_NAME') do @@ -96,10 +95,10 @@ describe azure_data_factory(resource_group: resource_group, name: 'DATA_FACTORY_ end ``` -**Test properties of a Data Factory.** +### Test properties of a Data Factory ```ruby -describe azure_data_factory(resource_group: resource_group, name: 'df_name') do +describe azure_data_factory(resource_group: `RESOURCE_GROUP`, name: 'NAME') do its('repo_configuration_type') { should include REPO_CONFIGURATION_TYPE } its('repo_configuration_project_name') { should include REPO_CONFIGURATION_PROJECT_NAME } its('repo_configuration_account_name') { should include REPO_CONFIGURATION_ACCOUNT_NAME } @@ -112,4 +111,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_dataset.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_dataset.md index 11d46e13a9..39cccbbd29 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_dataset.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_dataset.md @@ -10,17 +10,17 @@ identifier = "inspec/resources/azure/azure_data_factory_dataset Resource" parent = "inspec/resources/azure" +++ -Use the `azure_data_factory_dataset` InSpec audit resource to test properties related to an Azure Data Factory dataset. +Use the `azure_data_factory_dataset` InSpec audit resource to test the properties related to an Azure Data Factory dataset. See the [`Azure Data Factories Dataset documentation`](https://docs.microsoft.com/en-us/rest/api/datafactory/datasets/get) for additional information. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -33,7 +33,7 @@ end ## Parameters `resource_group` _(required)_ -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `dataset_name` _(required)_ : Name of the Azure resource to test. @@ -69,7 +69,7 @@ end ## Examples -**Test if Properties Match.** +### Test if properties match ```ruby describe azure_data_factory_dataset(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME', dataset_name: 'DATASET_NAME') do @@ -89,13 +89,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a dataset should exist +# If a dataset should exist. describe azure_data_factory_dataset(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME', dataset_name: 'DATASET_NAME') do it { should exist } end +``` + +### not_exists + +```ruby -# If a dataset should not exist +# If a dataset should not exist. describe azure_data_factory_dataset(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME', dataset_name: 'DATASET_NAME') do it { should_not exist } @@ -104,4 +109,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_datasets.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_datasets.md index 0263a48239..8b8522fd00 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_datasets.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_datasets.md @@ -10,21 +10,21 @@ identifier = "inspec/resources/azure/azure_data_factory_datasets Resource" parent = "inspec/resources/azure" +++ -Use the `azure_data_factory_datasets` InSpec audit resource to test properties of multiple Azure Data Factory datasets for a resource group or the entire subscription. +Use the `azure_data_factory_datasets` InSpec audit resource to test the properties of multiple Azure Data Factory datasets for a resource group or the entire subscription. See the [`Azure Data Factories Dataset documentation`](https://docs.microsoft.com/en-us/rest/api/datafactory/datasets/get) for additional information. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_data_factory_datasets` resource block returns all Azure dataset, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_data_factory_datasets` resource block returns all Azure datasets, either within a resource group (if provided) or within an entire Subscription. ```ruby describe azure_data_factory_datasets(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME') do @@ -35,7 +35,7 @@ end ## Parameters `resource_group` _(required)_ -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `factory_name` _(required)_ : The Azure Data factory name. @@ -77,11 +77,15 @@ end : **Field**: `linkedServiceName_type` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test if Properties Match.** +### Test if properties match ```ruby describe azure_data_factory_datasetsazure_data_factory_datasets(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME') do @@ -95,7 +99,7 @@ end This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://docs.chef.io/inspec/matchers/). -### Test if Any Dataset Exists in the Data Factory +### Test if any Dataset exists in the Data Factory ```ruby describe azure_data_factory_datasetsazure_data_factory_datasets(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME') do @@ -103,10 +107,10 @@ describe azure_data_factory_datasetsazure_data_factory_datasets(resource_group: end ``` -### Test That There Aren’t Any Datasets in a Data Factory +### Test that there are not any Datasets in a Data Factory ```ruby -# Should not exist if no dataset are in the data factory +# Should not exist if no datasets are in the data factory. describe azure_data_factory_datasetsazure_data_factory_datasets(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME') do it { should_not exist } @@ -115,4 +119,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_linked_service.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_linked_service.md index 59e24404f5..4f36637b5f 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_linked_service.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_linked_service.md @@ -14,11 +14,11 @@ Use the `azure_data_factory_linked_service` InSpec audit resource to test the pr ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -32,7 +32,7 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `factory_name` : The factory name. @@ -63,7 +63,7 @@ All the parameter sets are required for a valid query: ## Examples -**Test that a Linked Service exists.** +### Test that a linked service exists ```ruby describe azure_data_factory_linked_service(resource_group: `RESOURCE_GROUP`, factory_name: `FACTORY_NAME`, linked_service_name: `LINKED_SERVICE_NAME`) do @@ -71,7 +71,7 @@ describe azure_data_factory_linked_service(resource_group: `RESOURCE_GROUP`, fac end ``` -**Test that a linked service does not exist.** +### Test that a linked service does not exist ```ruby describe azure_data_factory_linked_service(resource_group: `RESOURCE_GROUP`, factory_name: `FACTORY_NAME`, linked_service_name: 'should not exit') do @@ -79,7 +79,7 @@ describe azure_data_factory_linked_service(resource_group: `RESOURCE_GROUP`, fac end ``` -**Test properties of a linked service.** +### Test properties of a linked service ```ruby describe azure_data_factory_linked_service(resource_group: `RESOURCE_GROUP`, name: 'FACTORY_NAME') do @@ -91,4 +91,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_linked_services.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_linked_services.md index d75251099a..14e6c92234 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_linked_services.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_linked_services.md @@ -14,15 +14,15 @@ Use the `azure_data_factory_linked_services` InSpec audit resource to test the p ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_data_factory_linked_services` resource block returns all Azure Linked Services, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_data_factory_linked_services` resource block returns all Azure Linked Services, either within a resource group (if provided) or an entire Subscription. ```ruby describe (resource_group: `RESOURCE_GROUP`, factory_name: 'FACTORY_NAME') do @@ -35,10 +35,10 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `factory_name` -: Azure factory name for which linked services are retrived. +: Azure factory name for which linked services are retrieved. ## Properties @@ -72,11 +72,15 @@ end : **Field**: `type_properties` -* For information on how to use filter criteria on plural resources, refer to [FilterTable usage](https://github.com/inspec/inspec/blob/master/dev-docs/filtertable-usage.md). +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test if any linked services exist in the resource group.** +### Test if any linked services exist in the resource group ```ruby describe azure_data_factory_linked_services(resource_group: `RESOURCE_GROUP`, factory_name: 'FACTORY_NAME') do @@ -85,17 +89,17 @@ describe azure_data_factory_linked_services(resource_group: `RESOURCE_GROUP`, fa end ``` -**Test that there aren't any Linked Services in a resource group.** +### Test that there are not any linked services in a resource group ```ruby -**Should not exist if no Linked Services are in the resource group.** +# Should not exist if no Linked Services are in the resource group. describe azure_data_factory_linked_services(resource_group: `RESOURCE_GROUP`, factory_name: 'FACTORY_NAME') do it { should_not exist } end ``` -**Filter Linked Services in a resource group by properties.** +### Filter linked services in a resource group by properties ```ruby describe azure_data_factory_linked_services(resource_group: `RESOURCE_GROUP`, factory_name: 'FACTORY_NAME') do @@ -107,4 +111,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipeline.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipeline.md index ce0fa61ba1..fd2b672417 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipeline.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipeline.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_data_factory_pipeline Resource" parent = "inspec/resources/azure" +++ -Use the `azure_data_factory_pipeline` InSpec audit resource to test properties of an Azure pipeline. +Use the `azure_data_factory_pipeline` InSpec audit resource to test the properties of an Azure pipeline. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `pipeline_name`, `factory_name` must be given as parameters. +`resource_group` and `pipeline_name`, or `factory_name` are required parameters. ```ruby describe azure_data_factory_pipeline(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME', pipeline_name: 'PIPELINE_NAME') do @@ -33,16 +33,15 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `factory_name` -: Name for the data factory that you want to create your pipeline in.. +: Data factory name where you want to create your pipeline. `pipeline_name` : The pipeline name. -All the parameter sets needs be provided for a valid query: -- `resource_group` , `factory_name` and `pipeline_name` +All the parameter sets need to be provided for a valid query: `resource_group` , `factory_name`, and `pipeline_name` ## Properties @@ -53,11 +52,11 @@ All the parameter sets needs be provided for a valid query: : The pipeline type. `properties` -: The properties of the Resource. +: The properties of the resource. ## Examples -**Test That A Pipeline Exists.** +### Test that a pipeline exists ```ruby describe azure_data_factory_pipeline(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME', pipeline_name: 'PIPELINE_NAME') do @@ -65,7 +64,7 @@ describe azure_data_factory_pipeline(resource_group: 'RESOURCE_GROUP', factory_n end ``` -**Test That A Pipeline Does Not Exist.** +### Test that a pipeline does not exist ```ruby describe azure_data_factory_pipeline(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME', pipeline_name: 'PIPELINE_NAME') do @@ -73,7 +72,7 @@ describe azure_data_factory_pipeline(resource_group: 'RESOURCE_GROUP', factory_n end ``` -**Test Properties Of A Pipeline.** +### Test properties of a pipeline ```ruby describe azure_data_factory_pipeline(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME', pipeline_name: 'PIPELINE_NAME') do @@ -83,4 +82,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipeline_run_resource.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipeline_run_resource.md index 7390ff6275..dadc699807 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipeline_run_resource.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipeline_run_resource.md @@ -12,15 +12,15 @@ parent = "inspec/resources/azure" Use the `azure_data_factory_pipeline_run_resource` InSpec audit resource to test the properties of an Azure Data Factory pipeline run. -For additional information, see the [`Azure Data Factory pipeline runs API documentation`](https://docs.microsoft.com/en-us/rest/api/datafactory/pipeline-runs/query-by-factory). +For additional information, see the [`Azure API documentation on Data Factory pipeline runs`](https://docs.microsoft.com/en-us/rest/api/datafactory/pipeline-runs/query-by-factory). ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -34,7 +34,7 @@ end `resource_group` _(required)_ -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `factory_name` _(required)_ @@ -69,7 +69,7 @@ end ## Examples -**Test properties of a pipeline runs.** +### Test properties of a pipeline runs ```ruby describe azure_data_factory_pipeline_run_resource(resource_group: `RESOURCE_GROUP`, name: 'FACTORY_NAME', run_id: `RUN_ID`) do @@ -99,4 +99,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipeline_run_resources.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipeline_run_resources.md index 5e79482440..a0d332fd35 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipeline_run_resources.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipeline_run_resources.md @@ -10,17 +10,17 @@ identifier = "inspec/resources/azure/azure_data_factory_pipeline_run_resources R parent = "inspec/resources/azure" +++ -Use the `azure_data_factory_pipeline_run_resources` InSpec audit resource to test the properties multiple Azure Data Factory pipeline runs for a resource group or the entire subscription. +Use the `azure_data_factory_pipeline_run_resources` InSpec audit resource to test the properties of multiple Azure Data Factory pipeline runs for a resource group or the entire subscription. -For additional information, see the [`Azure Data Factory pipeline runs API documentation`](https://docs.microsoft.com/en-us/rest/api/datafactory/pipeline-runs/query-by-factory). +For additional information, see the [`API documentation on Azure Data Factory pipeline runs`](https://docs.microsoft.com/en-us/rest/api/datafactory/pipeline-runs/query-by-factory). ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -36,13 +36,12 @@ end `resource_group` _(required)_ -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `factory_name` _(required)_ : Azure factory name for which pipeline runs are retrieved. - ## Properties `invokedBy_names` @@ -75,11 +74,15 @@ end : **Field**: `runEnd` -* For information on how to use filter criteria on plural resources, refer to [FilterTable usage](https://github.com/inspec/inspec/blob/master/dev-docs/filtertable-usage.md). +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Filter pipeline runs in a resource group by properties.** +### Filter pipeline runs in a resource group by properties ```ruby describe azure_data_factory_pipeline_run_resources(resource_group: `RESOURCE_GROUP`, factory_name: 'FACTORY_NAME') do @@ -102,7 +105,7 @@ end ### Test that there aren't any pipeline runs in a resource group ```ruby -# Should not exist if no pipeline runs are in the resource group +# Should not exist if no pipeline runs are in the resource group. describe azure_data_factory_pipeline_run_resources(resource_group: `RESOURCE_GROUP`, factory_name: 'FACTORY_NAME') do it { should_not exist } @@ -111,4 +114,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipelines.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipelines.md index c937dd0bb8..e4f2eac5be 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipelines.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_factory_pipelines.md @@ -10,26 +10,22 @@ identifier = "inspec/resources/azure/azure_data_factory_pipelines Resource" parent = "inspec/resources/azure" +++ -Use the `azure_data_factory_pipelines` InSpec audit resource to test properties related to pipeline for a resource group or the entire subscription. +Use the `azure_data_factory_pipelines` InSpec audit resource to test the properties related to a pipeline for a resource group or the entire subscription. ## Azure Rest API Version, Endpoint, And HTTP Client Parameters -This resource interacts with API versions supported by the resource provider. -The `api_version` can be defined as a resource parameter. -If not provided, the latest version will be used. -For more information, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md" >}}). +This resource interacts with API versions supported by the resource provider. The `api_version` can be defined as a resource parameter. +If not provided, the latest version will be used. For more information, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md" >}}). -Unless defined, `azure_cloud` global endpoint, and default values for the HTTP client will be used. -For more information, refer to the resource pack [README](https://github.com/inspec/inspec-azure/blob/main/README.md). -For api related info : [`Azure pipeline Docs`](https://docs.microsoft.com/en-us/rest/api/datafactory/pipelines/list-by-factory). +Unless defined, the `azure_cloud` global endpoint and default values for the HTTP client will be used. For more information, refer to the resource pack [README](https://github.com/inspec/inspec-azure/blob/main/README.md). For API related information, [`Azure pipeline Docs`](https://docs.microsoft.com/en-us/rest/api/datafactory/pipelines/list-by-factory). -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_data_factory_pipelines` resource block returns all Azure pipeline, either within a resource group (if provided), or within an entire subscription. +An `azure_data_factory_pipelines` resource block returns all Azure pipelines, either within a resource group (if provided) or an entire subscription. ```ruby describe azure_data_factory_pipelines(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME') do @@ -37,15 +33,15 @@ describe azure_data_factory_pipelines(resource_group: 'RESOURCE_GROUP', factory_ end ``` -`resource_group` and `factory_name` must be given as parameters. +`resource_group` and `factory_name` are required parameters. ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `factory_name` -: Azure Factory Name for which pipeline are being retrived. +: Azure Factory Name for which pipeline is being retrieved. ## Properties @@ -55,7 +51,7 @@ end : **Field**: `name` `ids` -: A list of pipeline IDs . +: A list of pipeline IDs. : **Field**: `id` @@ -64,11 +60,15 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test If Any Pipeline Exist In The Resource Group.** +### Test if any pipeline exists in the resource group ```ruby describe azure_data_factory_pipelines(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME') do @@ -77,16 +77,16 @@ describe azure_data_factory_pipelines(resource_group: 'RESOURCE_GROUP', factory_ end ``` -**Test that there aren't any pipeline in a resource group.** +### Test that there are not any pipelines in a resource group ```ruby -**Should not exist if no pipeline are in the resource group.** +# Should not exist if no pipelines is in the resource group. -describe azure_data_factory_pipelines(resource_group: 'example', factory_name: 'fake') do +describe azure_data_factory_pipelines(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_filesystem.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_filesystem.md index 64e8bca624..085313929a 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_filesystem.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_filesystem.md @@ -14,11 +14,11 @@ Use the `azure_data_lake_storage_gen2_filesystem` InSpec audit resource to test ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -40,7 +40,7 @@ end `name` _(required)_ -: Name of the Azure Date Lake Storage Gen2 to test. +: Name of the Azure Data Lake Storage Gen2 to test. `account_name` _(required)_ @@ -79,14 +79,13 @@ end `date` : Date string of the request. - For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/filesystem/get-properties) for other properties available. ## Examples -**Test that the Data Lake Storage Gen2 filesystem has namespace enabled.** +### Test that the Data Lake Storage Gen2 filesystem has namespace enabled ```ruby describe azure_data_lake_storage_gen2_filesystem(account_name: 'ACCOUNT_NAME', name: 'FILE_SYSTEM') do @@ -101,12 +100,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If the Data Lake Storage Gen2 Filesystem is found, it exists +# If the Data Lake Storage Gen2 Filesystem is found, it exists. + describe azure_data_lake_storage_gen2_filesystem(account_name: 'ACCOUNT_NAME', name: 'FILE_SYSTEM') do it { should exist } end +``` + +### not_exists + +```ruby +# Ff the Data Lake Storage Gen2 Filesystem is not found, it exists. -# Ff the Data Lake Storage Gen2 Filesystem is not found, it exists describe azure_data_lake_storage_gen2_filesystem(account_name: 'ACCOUNT_NAME', name: 'FILE_SYSTEM') do it { should_not exist } end @@ -114,4 +119,4 @@ end ## Azure Permissions -Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `contributor` role on the subscription and `Storage Blob Data Contributor` role on the ADLS Gen2 Storage Account you wish to test. +Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `contributor` role on the subscription and `Storage Blob Data Contributor` role on the **ADLS Gen2 Storage Account** you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_filesystems.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_filesystems.md index 6f8158f99a..c825776952 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_filesystems.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_filesystems.md @@ -14,11 +14,11 @@ Use the `azure_data_lake_storage_gen2_filesystems` InSpec audit resource to test ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -43,17 +43,17 @@ end ## Properties `names` -: Unique names for all Azure Storage account Filesystems. +: Unique names for all Azure Storage Account Filesystems. : **Field**: `name` `lastModifieds` -: Last modified timestamps of Azure Storage account Filesystem. +: Last modified timestamps of Azure Storage Account Filesystem. : **Field**: `lastModified` `eTags` -: A list of eTags for all the Azure Storage account Filesystems. +: A list of eTags for all the Azure Storage Account Filesystems. : **Field**: `eTag` @@ -67,12 +67,16 @@ end : **Field**: `DenyEncryptionScopeOverrides` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/filesystem/list) for other properties available. ## Examples -**Loop Through Data Lake Storage Gen2 Filesystems by Their Names and Verify That Each Exists.** +### Loop through Data Lake Storage Gen2 Filesystems by their names and verify that each exists ```ruby azure_data_lake_storage_gen2_filesystems(account_name: 'ACCOUNT_NAME').names.each do |name| @@ -82,7 +86,7 @@ azure_data_lake_storage_gen2_filesystems(account_name: 'ACCOUNT_NAME').names.eac end ``` -**Test To Ensure Data Lake Storage Gen2 Filesystems With ‘$account-encryption-key’ Encryption Scope.** +### Test To ensure Data Lake Storage Gen2 Filesystems With ‘$account-encryption-key’ encryption scope ```ruby describe azure_data_lake_storage_gen2_filesystems(account_name: 'ACCOUNT_NAME').where(DefaultEncryptionScope: '$account-encryption-key') do @@ -92,18 +96,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Data Lake Storage Gen2 filesystems are present in the project and in the resource group +# Should not exist if no Data Lake Storage Gen2 filesystems are present in the project and the resource group. describe azure_data_lake_storage_gen2_filesystems(account_name: 'ACCOUNT_NAME') do it { should_not exist } end +``` + +### not_exists -# Should exist if the filter returns at least one Data Lake Storage Gen2 filesystem in the project and in the resource group +```ruby +# Should exist if the filter returns at least one Data Lake Storage Gen2 filesystem in the project and the resource group. describe azure_data_lake_storage_gen2_filesystems(account_name: 'ACCOUNT_NAME') do it { should exist } @@ -112,4 +122,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_path.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_path.md index a24f1a7a03..3d4108f8f7 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_path.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_path.md @@ -14,11 +14,11 @@ Use the `azure_data_lake_storage_gen2_path` InSpec audit resource to test the pr ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -40,7 +40,7 @@ end : The filesystem identifier. `account_name` _(required)_ -: Azure Storage Account Name. +: Azure Storage account name. `name` _(required)_ : The file or directory path. @@ -51,7 +51,7 @@ end ## Properties `last_modified` -: Last Modified Timestamp of the resource. +: Last modified timestamp of the resource. `etag` : HTTP strong entity tag value. @@ -63,43 +63,42 @@ end : Request ID. `x_ms_version` -: Version of the API. +: API version. `date` -: Date String of the request. +: Date string of the request. `content_length` -: Content Length of the file. +: Content-Length of the file. `content_type` -: Content Type. +: Content type. `content_md5` -: MD5 of the Content uploaded. +: MD5 of the content uploaded. `accept_ranges` : File size described measurement. `bytes`. `x_ms_resource_type` -: Resource Type of the uploaded. `file`. +: Resource type of the uploaded. `file`. `x_ms_lease_state` : If the file is available or not. `x_ms_lease_status` -: Status of lease. +: Status of the lease. `x_ms_server_encrypted` : If the file is encrypted on the server. - For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/get-properties) for other properties available. ## Examples -**Test that the Data Lake Storage Gen 2 Filesystem Path is server encrypted.** +### Test that the Data Lake Storage Gen 2 Filesystem Path is server encrypted ```ruby describe azure_data_lake_storage_gen2_path(account_name: 'ACCOUNT_NAME', filesystem: 'FILE_SYSTEM', name: 'PATHNAME') do @@ -114,12 +113,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If the Data Lake Storage Gen 2 Filesystem is found, it will exist +# If the Data Lake Storage Gen 2 Filesystem is found, it will exist. + describe azure_data_lake_storage_gen2_path(account_name: 'ACCOUNT_NAME', filesystem: 'FILE_SYSTEM', name: 'PATHNAME') do it { should exist } end +``` + +### not_exists + +```ruby +# if the Data Lake Storage Gen 2 Filesystem is not found, it will not exist. -# if the Data Lake Storage Gen 2 Filesystem is not found, it will not exist describe azure_data_lake_storage_gen2_path(account_name: 'ACCOUNT_NAME', filesystem: 'FILE_SYSTEM', name: 'PATHNAME') do it { should_not exist } end @@ -127,4 +132,4 @@ end ## Azure Permissions -Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `contributor` role on the subscription and `Storage Blob Data Contributor` role on the ADLS Gen2 Storage Account you wish to test. \ No newline at end of file +Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `contributor` role on the subscription and `Storage Blob Data Contributor` role on the **ADLS Gen2 Storage Account** you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_paths.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_paths.md index 1c0815ba10..344b2b2980 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_paths.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_data_lake_storage_gen2_paths.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_data_lake_storage_gen2_paths Resource parent = "inspec/resources/azure" +++ -Use the `azure_data_lake_storage_gen2_paths` InSpec audit resource to test the properties related to all Azure Data Lake Storage Gen2 Filesystem Paths within a project. +Use the `azure_data_lake_storage_gen2_paths` InSpec audit resource to test the properties related to all Azure Data Lake Storage Gen2 Filesystem paths within a project. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_data_lake_storage_gen2_paths` resource block returns all Azure Data Lake Storage Gen2 Filesystem Paths within a project. +An `azure_data_lake_storage_gen2_paths` resource block returns all Azure Data Lake Storage Gen2 Filesystem paths within a project. ```ruby describe azure_data_lake_storage_gen2_paths(account_name: 'ACCOUNT_NAME', filesystem: 'ADLS FILESYSTEM') do @@ -44,32 +44,35 @@ end ## Properties `names` -: Unique names for all the paths in the filesystem. +: Unique names for all the paths in the Filesystem. : **Field**: `name` `lastModifieds` -: Last modified timestamps of all the paths in the filesystem. +: Last modified timestamps of all the paths in the Filesystem. : **Field**: `lastModified` `eTags` -: A list of eTags for all the paths in the filesystem. +: A list of eTags for all the paths in the Filesystem. : **Field**: `eTag` `contentLengths` -: A list of Content Length of all the paths in the filesystem . +: A list of Content-Length of all the paths in the Filesystem. : **Field**: `contentLength` +{{< note >}} -{{% inspec_filter_table %}} +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/list) for other properties available. ## Examples -**Loop through Data Lake Storage Gen2 Filesystem Paths by their names.** +### Loop through Data Lake Storage Gen2 Filesystem paths by their names ```ruby azure_data_lake_storage_gen2_paths(account_name: 'ACCOUNT_NAME', filesystem: 'ADLS FILESYSTEM').names.each do |name| @@ -79,7 +82,7 @@ azure_data_lake_storage_gen2_paths(account_name: 'ACCOUNT_NAME', filesystem: 'AD end ``` -**Test to ensure Data Lake Storage Gen2 Filesystem Paths with file size greater than 2 MB.** +### Test to ensure Data Lake Storage Gen2 Filesystem paths with file size greater than 2 MB ```ruby describe azure_data_lake_storage_gen2_paths(account_name: 'ACCOUNT_NAME', filesystem: 'ADLS FILESYSTEM').where{ contentLength > 2097152 } do @@ -89,18 +92,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Data Lake Storage Gen2 Filesystems are present in the project and in the resource group +# Should not exist if no Data Lake Storage Gen2 Filesystems are present in the project and in the resource group. describe azure_data_lake_storage_gen2_paths(account_name: 'ACCOUNT_NAME', filesystem: 'ADLS FILESYSTEM') do it { should_not exist } end +``` -# Should exist if the filter returns at least one Migrate Assessment in the project and in the resource group +### not_exists + +```ruby +# Should exist if the filter returns at least one Migrate Assessment in the project and in the resource group. describe azure_data_lake_storage_gen2_paths(account_name: 'ACCOUNT_NAME', filesystem: 'ADLS FILESYSTEM') do it { should exist } @@ -109,4 +118,4 @@ end ## Azure Permissions -Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `contributor` role on the subscription and `Storage Blob Data Contributor` role on the ADLS Gen2 Storage Account you wish to test. \ No newline at end of file +Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `contributor` role on the subscription and `Storage Blob Data Contributor` role on the ADLS Gen2 Storage Account you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_db_migration_service.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_db_migration_service.md index 9d7cb89297..ca36852a66 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_db_migration_service.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_db_migration_service.md @@ -10,21 +10,22 @@ identifier = "inspec/resources/azure/azure_db_migration_service Resource" parent = "inspec/resources/azure" +++ -Use the `azure_db_migration_service` InSpec audit resource to test properties related to a Azure DB Migration Service. +Use the `azure_db_migration_service` InSpec audit resource to test the properties related to a Azure DB Migration Service. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `service_name` must be given as a parameter. +`resource_group` and `service_name` are required parameter. + ```ruby -describe azure_db_migration_service(resource_group: 'MyResourceGroup', service_name: 'dbbackup_to_uat_migration_servicet') do +describe azure_db_migration_service(resource_group: 'RESOURCE_GROUP', service_name: 'SERVICE_NAME') do it { should exist } its('name') { should cmp 'inspec-cloud-pack-test' } its('type') { should cmp 'Microsoft.DataMigration/services' } @@ -33,22 +34,22 @@ describe azure_db_migration_service(resource_group: 'MyResourceGroup', service_n its('location') { should cmp 'southcentralus' } end ``` + ```ruby -describe azure_db_migration_service(resource_group: 'MyResourceGroup', service_name: 'dbbackup_to_uat_migration_service') do - it { should exist } +describe azure_db_migration_service(resource_group: 'RESOURCE_GROUP', service_name: 'SERVICE_NAME') do + it { should exist } end ``` ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `service_name` : Name of the Azure DB Migration service to test. -The parameter set should be provided for a valid query: -- `resource_group` and `service_name` +The parameter set should be provided for a valid query: `resource_group` and `service_name`. ## Properties @@ -74,7 +75,7 @@ The parameter set should be provided for a valid query: : The unique name of the SKU, such as 'P3'. `sku.size` -: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines. +: The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family. For example, 'A1' for virtual machines. `sku.tier` : The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium'. @@ -86,29 +87,26 @@ The parameter set should be provided for a valid query: : The resource's provisioning state. `properties.virtualSubnetId` -: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined. +: The ID of the `Microsoft.Network/virtualNetworks/subnets` resource to which the service should be joined. `properties.virtualNicId` : The ID of the Azure Network Interface. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/datamigration/services/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test <>.** - ```ruby -describe azure_db_migration_service(resource_group: 'MyResourceGroup', service_name: 'dbbackup_to_uat_migration_service') do +describe azure_db_migration_service(resource_group: 'RESOURCE_GROUP', service_name: 'NAME') do its('properties.provisioningState') { should eq 'Succeeded' } end ``` -**Test <>.** ```ruby -describe azure_db_migration_service(resource_group: 'MyResourceGroup', service_name: 'dbbackup_to_uat_migration_service') do +describe azure_db_migration_service(resource_group: 'RESOURCE_GROUP', service_name: 'NAME') do its('sku.name') { should 'Standard_1vCores' } end ``` @@ -120,18 +118,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a azure_db_migration_service is found it will exist +# If a azure_db_migration_service is found, it will exist. -describe azure_db_migration_service(resource_group: 'MyResourceGroup', service_name: 'dbbackup_to_uat_migration_service') do +describe azure_db_migration_service(resource_group: 'RESOURCE_GROUP', service_name: 'NAME') do it { should exist } end +``` + +### not_exists + +```ruby +# azure_db_migration_services that aren't found, will not exist. -# azure_db_migration_services that aren't found will not exist -describe azure_db_migration_service(resource_group: 'MyResourceGroup', service_name: 'dbbackup_to_uat_migration_service') do +describe azure_db_migration_service(resource_group: 'RESOURCE_GROUP', service_name: 'NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_db_migration_services.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_db_migration_services.md index 100b453669..3955b9ea54 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_db_migration_services.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_db_migration_services.md @@ -10,22 +10,22 @@ identifier = "inspec/resources/azure/azure_db_migration_services Resource" parent = "inspec/resources/azure" +++ -Use the `azure_db_migration_services` InSpec audit resource to test properties related to Azure DB Migration Service for a resource group or the entire subscription. +Use the `azure_db_migration_services` InSpec audit resource to test the properties related to Azure DB Migration Service for a resource group or the entire subscription. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_db_migration_services` resource block returns all Azure DB Migration Services within a Resource Group. +An `azure_db_migration_services` resource block returns all Azure DB Migration Services within a resource group. ```ruby -describe azure_db_migration_services(resource_group: 'my-rg') do +describe azure_db_migration_services(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -33,7 +33,7 @@ end or ```ruby -describe azure_db_migration_services(resource_group: 'my-rg') do +describe azure_db_migration_services(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -47,12 +47,12 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` `names` -: A list of name for all the Resource names. +: A list of names for all the resource names. : **Field**: `name` @@ -72,7 +72,7 @@ end : **Field**: `kind` `etags` -: A list of HTTP strong entity tag value. +: A list of HTTP strong entity tag values. : **Field**: `etag` @@ -107,25 +107,29 @@ end : **Field**: `virtual_nic_id` `virtual_subnet_ids` -: A list of vitual subnet IDs from the properties. +: A list of virtual subnet IDs from the properties. : **Field**: `virtual_subnet_id` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through DB Migration Services by their names.** +### Loop through DB Migration Services by their names ```ruby -azure_db_migration_services(resource_group: 'my-rg').names.each do |name| +azure_db_migration_services(resource_group: 'RESOURCE_GROUP').names.each do |name| describe azure_db_migration_service(service_name: name) do it { should exist } end end ``` -**Test that there are DB Migration Services that includes a certain string in their names (Client Side Filtering).** +### Test that there are DB Migration Services that includes a certain string in their names (Client Side Filtering) ```ruby describe azure_db_migration_services(resource_group: 'my-rg').where { name.include?('UAT') } do @@ -135,18 +139,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no db migration service are in the resource group +# Should not exist if no db migration service are in the resource group. describe azure_db_migration_services(resource_group: 'my-rg') do it { should_not exist } end +``` -# Should exist if the filter returns at least one db migration service +### not_exists + +```ruby +# Should exist if the filter returns at least one db migration service. describe azure_db_migration_services(resource_group: 'my-rg') do it { should exist } @@ -155,4 +165,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_ddos_protection_resource.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_ddos_protection_resource.md index fa592bd36d..11afdf7951 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_ddos_protection_resource.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_ddos_protection_resource.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_ddos_protection_resource Resource" parent = "inspec/resources/azure" +++ -Use the `azure_ddos_protection_resource` InSpec audit resource to test properties of a DDoS protection plan resource. +Use the `azure_ddos_protection_resource` InSpec audit resource to test the properties of a DDoS protection plan resource. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -30,16 +30,13 @@ describe azure_ddos_protection_resource(resource_group: 'RESOURCE_GROUP', name: end ``` - ## Parameters +## Parameters | Name | Description | |--------------------------------|--------------------------------------------------------------| -| resource_group | Azure resource group that the targeted resource resides in. | -| name | Name of the Azure DDoS Protection Plan resource to test. | -| resource_id | The Azure DDoS Protection Plan resource ID to test. | - - -The `resource_group` and the DDoS protection plan resource `name`, or the `resource_id` are required parameters. +| resource_group | Azure resource group where the targeted resource resides. | +| name | Name of the Azure DDoS protection plan resource to test. | +| resource_id | The Azure DDoS protection plan resource ID to test. | ## Properties @@ -50,22 +47,20 @@ The `resource_group` and the DDoS protection plan resource `name`, or the `resou : The resource type. `provisioning_state` -: The provisioning state of DDoS protection plan. Valid values: `Deleting`, `Failed`, `Succeeded`, `Updating`. +: The provisioning state of the DDoS protection plan. Valid values: `Deleting`, `Failed`, `Succeeded`, and `Updating`. `virtual_networks` : The list of virtual networks associated with the DDoS protection plan resource. `resource_guid` -: The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. - +: The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrates the resource across subscriptions or resource groups. Also, refer to the [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/ddos-protection-plans/get) -for other properties available. -Access any attribute in the response by separating the key names with a period (`.`). +for other properties available. Access any attribute in the response by separating the key names with a period (`.`). ## Examples -**Ensure that the DDoS protection plan resource has the correct type.** +### Test to ensure that the DDoS protection plan resource has the correct type ```ruby describe azure_ddos_protection_resource(resource_group: 'RESOURCE_GROUP', name: 'DDOS_PROTECTION_PLAN_NAME') do @@ -73,7 +68,7 @@ describe azure_ddos_protection_resource(resource_group: 'RESOURCE_GROUP', name: end ``` -**Ensure that the DDoS protection plan resource is in successful state.** +### Test to ensure that the DDoS protection plan resource is in a successful state ```ruby describe azure_ddos_protection_resource(resource_group: 'RESOURCE_GROUP', name: 'DDOS_PROTECTION_PLAN_NAME') do @@ -81,7 +76,7 @@ describe azure_ddos_protection_resource(resource_group: 'RESOURCE_GROUP', name: end ``` -**Ensure that the DDoS protection plan resource is from same location.** +### Test to ensure that the DDoS protection plan resource is from the same location ```ruby describe azure_ddos_protection_resource(resource_group: 'RESOURCE_GROUP', name: 'DDOS_PROTECTION_PLAN_NAME') do @@ -96,13 +91,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a DDoS protection plan resource is found it will exist +# If a DDoS protection plan resource is found, it will exist. describe azure_ddos_protection_resource(resource_group: 'RESOURCE_GROUP', name: 'DDOS_PROTECTION_PLAN_NAME') do it { should exist } end +``` + +### not_exists + +```ruby +# DDoS protection plan resources that aren't found, will not exist. -# DDoS protection plan resources that aren't found will not exist describe azure_ddos_protection_resource(resource_group: 'RESOURCE_GROUP', name: 'DDOS_PROTECTION_PLAN_NAME') do it { should_not exist } end @@ -110,4 +110,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_ddos_protection_resources.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_ddos_protection_resources.md index f11788c1fa..72ce3d4312 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_ddos_protection_resources.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_ddos_protection_resources.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_ddos_protection_resources Resource" parent = "inspec/resources/azure" +++ -Use the `azure_ddos_protection_resources` InSpec audit resource to test properties of DDoS protection plans in a resource group. +Use the `azure_ddos_protection_resources` InSpec audit resource to test the properties of DDoS protection plans in a resource group. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_ddos_protection_resources` resource block returns all Azure bastion hosts, either within a Resource Group (if provided) +An `azure_ddos_protection_resources` resource block returns all Azure bastion hosts, within a resource group (if provided). ```ruby describe azure_ddos_protection_resources(resource_group: 'RESOURCE_GROUP') do @@ -33,7 +33,7 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. ## Properties @@ -63,19 +63,21 @@ end : **Field**: `type` `resource_guids` -: The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +: The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrates the resource across subscriptions or resource groups. : **Field**: `resource_guid` +{{< note >}} -{{% inspec_filter_table %}} +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} -Also, refer to the [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/ddos-protection-plans/list) for all available properties. -Access any attribute in the response by separating the key names with a period (`.`). +{{< /note>}} + +Also, refer to the [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/ddos-protection-plans/list) for all available properties. Access any attribute in the response by separating the key names with a period (`.`). ## Examples -**Ensure that the DDoS protection plan resource is in successful state.** +### Test to ensure that the DDoS protection plan resource is in a successful state ```ruby describe azure_ddos_protection_resources(resource_group: 'RESOURCE_GROUP') do @@ -83,7 +85,7 @@ describe azure_ddos_protection_resources(resource_group: 'RESOURCE_GROUP') do end ``` -**Ensure that a DDoS protection plan resource is from a location.** +### Test to ensure that a DDoS protection plan resource is from a location ```ruby describe azure_ddos_protection_resources(resource_group: 'RESOURCE_GROUP') do @@ -91,7 +93,7 @@ describe azure_ddos_protection_resources(resource_group: 'RESOURCE_GROUP') do end ``` -**Test if any DDoS protection plan exists in the resource group.** +### Test if any DDoS protection plan exists in the resource group ```ruby describe azure_ddos_protection_resources(resource_group: 'RESOURCE_GROUP') do @@ -101,12 +103,14 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no bastion hots are in the resource group +# Should not exist if no bastion hots are in the resource group. describe azure_ddos_protection_resources(resource_group: 'RESOURCE_GROUP') do it { should_not exist } @@ -115,4 +119,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_dns_zones_resource.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_dns_zones_resource.md index 6e76fd6635..94d54b73c2 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_dns_zones_resource.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_dns_zones_resource.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_dns_zones_resource Resource" parent = "inspec/resources/azure" +++ -Use the `azure_dns_zones_resource` InSpec audit resource to test properties of an Azure DNS zone. +Use the `azure_dns_zones_resource` InSpec audit resource to test the properties of an Azure DNS zone. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -This resource requires either the `resource_group` and DNS zone resource `name`, or the `resource_id`. +This resource requires either the `resource_group`, and DNS zone resource `name` or the `resource_id`. ```ruby describe azure_dns_zones_resource(resource_group: 'RESOURCE_GROUP_NAME', name: 'DNS_ZONE_NAME') do @@ -30,7 +30,7 @@ describe azure_dns_zones_resource(resource_group: 'RESOURCE_GROUP_NAME', name: ' end ``` -or +Or ```ruby describe azure_dns_zones_resource(resource_id: 'DNS_ZONE_RESOURCE_ID') do @@ -41,7 +41,7 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `name` : Name of the DNS zone to test. @@ -74,14 +74,12 @@ The `resource_group` and `name`, or the `resource_id` are required parameters. `location` : The DNS zone resource location. - Also, refer to the [Azure documentation](https://docs.microsoft.com/en-us/rest/api/dns/zones/get) -for other available properties. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +for other available properties. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test that the Azure DNS zone resource has the correct resource type.** +### Test that the Azure DNS zone resource has the correct resource type ```ruby describe azure_dns_zones_resource(resource_group: 'RESOURCE_GROUP_NAME', name: 'DNS_ZONE_NAME') do @@ -89,7 +87,7 @@ describe azure_dns_zones_resource(resource_group: 'RESOURCE_GROUP_NAME', name: ' end ``` -**Test that the location of the Azure DNS zone resource is `global`.** +### Test that the location of the Azure DNS zone resource is 'global' ```ruby describe azure_dns_zones_resource(resource_group: 'RESOURCE_GROUP_NAME', name: 'DNS_ZONE_NAME') do @@ -104,13 +102,14 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a DNS Zone resource is found it will exist +# If a DNS Zone resource is found, it will exist. describe azure_dns_zones_resource(resource_group: 'RESOURCE_GROUP_NAME', name: 'DNS_ZONE_NAME') do it { should exist } end -# DNS Zone resources that aren't found will not exist +# DNS Zone resources that aren't found, will not exist. + describe azure_dns_zones_resource(resource_group: 'RESOURCE_GROUP_NAME', name: 'DNS_ZONE_NAME') do it { should_not exist } end @@ -118,4 +117,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_dns_zones_resources.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_dns_zones_resources.md index 8742850e49..44af42f116 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_dns_zones_resources.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_dns_zones_resources.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_dns_zones_resources Resource" parent = "inspec/resources/azure" +++ -Use the `azure_dns_zones_resources` InSpec audit resource to test properties related to all Azure DNS zones for a resource group or an entire subscription. +Use the `azure_dns_zones_resources` InSpec audit resource to test the properties related to all Azure DNS zones for a resource group or an entire subscription. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_dns_zones_resources` resource block returns all Azure DNS Zones within within a resource group. +An `azure_dns_zones_resources` resource block returns all Azure DNS Zones within a resource group. ```ruby describe azure_dns_zones_resources do @@ -76,11 +76,15 @@ This resource does not require any parameters. : **Field**: `name_servers` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test that a DNS zone has has the correct type.** +### Test that a DNS zone has the correct type ```ruby describe azure_dns_zones_resources do @@ -88,7 +92,7 @@ describe azure_dns_zones_resources do end ``` -**Test that a DNS zone resource has a `Succeeded` provisioning state.** +### Test that a DNS zone resource has a 'Succeeded' provisioning state ```ruby describe azure_dns_zones_resources do @@ -96,7 +100,7 @@ describe azure_dns_zones_resources do end ``` -**Test that a DNS zone has the `global` location.** +### Test that a DNS zone has the 'global' location ```ruby describe azure_dns_zones_resources do @@ -104,7 +108,7 @@ describe azure_dns_zones_resources do end ``` -**Test if any Azure DNS zone exists in the resource group.** +### Test if any Azure DNS zone exists in the resource group ```ruby describe azure_dns_zones_resources do @@ -114,11 +118,13 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -Test that there aren't any Azure DNS zones in the resource group. +Test that there are not any Azure DNS zones in the resource group. ```ruby describe azure_dns_zones_resources do @@ -128,4 +134,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_event_hub_authorization_rule.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_event_hub_authorization_rule.md index 6f59e91c53..a4533a0004 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_event_hub_authorization_rule.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_event_hub_authorization_rule.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_event_hub_authorization_rule Resource parent = "inspec/resources/azure" +++ -Use the `azure_event_hub_authorization_rule` InSpec audit resource to test properties and configuration of an Azure Event Hub Authorization Rule within a Resource Group. +Use the `azure_event_hub_authorization_rule` InSpec audit resource to test the properties and configuration of an Azure Event Hub Authorization Rule within a resource group. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group`, `namespace_name`, `event_hub_endpoint` and `name` or the `resource_id` must be given as a parameter. +`resource_group`, `namespace_name`, `event_hub_endpoint` and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_event_hub_authorization_rule(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', event_hub_endpoint: 'myeventhub', name: 'my-auth-rule') do +describe azure_event_hub_authorization_rule(resource_group: 'RESOURCE_GROUP', namespace_name: 'EVENT_NAME', event_hub_endpoint: 'HUB_NAME', name: 'AUTH_RULE') do it { should exist } end ``` + ```ruby describe azure_event_hub_authorization_rule(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}') do it { should exist } @@ -37,7 +39,7 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `resource-group-name`. +: Azure resource group where the targeted resource resides. `namespace_name` : The unique name of the Event Hub Namespace. @@ -46,38 +48,39 @@ end : The unique name of the Event Hub Name. `name` -: The unique name of the targeted resource. `resource-name`. +: The unique name of the targeted resource. `authorization_rule` : Alias for the `name` parameter. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` -- `resource_group`, `namespace_name`, `event_hub_endpoint` and `name` -- `resource_group`, `namespace_name`, `event_hub_endpoint` and `authorization_rule` +- `resource_group`, `namespace_name`, `event_hub_endpoint`, and `name` +- `resource_group`, `namespace_name`, `event_hub_endpoint`, and `authorization_rule` ## Properties `properties.rights` : The list of rights associated with the rule. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/eventhub/2017-04-01/authorization%20rules%20-%20event%20hubs/getauthorizationrule) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/eventhub/stable/authorization-rules-event-hubs/get-authorization-rule?tabs=HTTP) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test the Name of an Authorization Rule.** +### Test the name of an Authorization Rule ```ruby -describe azure_event_hub_authorization_rule(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', event_hub_endpoint: 'myeventhub', name: 'my-auth-rule') do +describe azure_event_hub_authorization_rule(resource_group: 'RESOURCE_GROUP', namespace_name: 'EVENT_NAME', event_hub_endpoint: 'HUB_NAME', name: 'AUTH_RULE') do its('name') { should cmp 'my-auth-rule' } end ``` + ```ruby describe azure_event_hub_authorization_rule(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}') do its('name') { should cmp 'my-auth-rule' } @@ -91,19 +94,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect the resource to always exist +# If we expect the resource to always exist. -describe azure_event_hub_authorization_rule(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', event_hub_endpoint: 'myeventhub', name: 'my-auth-rule') do +describe azure_event_hub_authorization_rule(resource_group: 'RESOURCE_GROUP', namespace_name: 'EVENT_NAME', event_hub_endpoint: 'HUB_NAME', name: 'AUTH_RULE') do it { should exist } end +``` + +### not_exists -# If we expect the resource not to exist +```ruby +# If we expect the resource not to exist. -describe azure_event_hub_authorization_rule(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', event_hub_endpoint: 'myeventhub', name: 'my-auth-rule') do +describe azure_event_hub_authorization_rule(resource_group: 'RESOURCE_GROUP', namespace_name: 'EVENT_NAME', event_hub_endpoint: 'HUB_NAME', name: 'AUTH_RULE') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_event_hub_event_hub.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_event_hub_event_hub.md index dfe2578088..36617d2942 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_event_hub_event_hub.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_event_hub_event_hub.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_event_hub_event_hub Resource" parent = "inspec/resources/azure" +++ -Use the `azure_event_hub_event_hub` InSpec audit resource to test properties of an Azure Event Hub description within a Resource Group. +Use the `azure_event_hub_event_hub` InSpec audit resource to test the properties of an Azure Event Hub description within a resource group. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group`, `namespace_name` and `name` or the `resource_id` must be given as a parameter. +`resource_group`, `namespace_name` and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_event_hub_event_hub(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', name: 'myeventhub') do +describe azure_event_hub_event_hub(resource_group: 'RESOURCE_GROUP', namespace_name: 'EVENT_NAME', name: 'HUB_NAME') do it { should exist } end ``` + ```ruby describe azure_event_hub_event_hub(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}') do it { should exist } @@ -37,21 +39,22 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `resourceGroupName`. +: Azure resource group where the targeted resource resides. `namespace_name` -: The unique name of the Event Hub Namespace. `namespaceName`. +: The unique name of the Event Hub Namespace. `name` -: The unique name of the targeted resource. `eventHubName`. +: The unique name of the targeted resource. `event_hub_name` : Alias for the `name` parameter. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group`, `namespace_name` and `name` - `resource_group`, `namespace_name` and `event_hub_name` @@ -59,22 +62,22 @@ Either one of the parameter sets can be provided for a valid query: ## Properties `properties.messageRetentionInDays` -: Number of days to retain the events for this Event Hub, value should be 1 to 7 days. +: Number of days to retain the events for this Event Hub. The value should be 1 to 7 days. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/eventhub/2017-04-01/eventhubs/get#eventhub) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/eventhub/get-event-hub) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test the Message Retention Time of an Event Hub.** +### Test the message retention time of an event hub ```ruby -describe azure_event_hub_event_hub(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', name: 'myeventhub') do +describe azure_event_hub_event_hub(resource_group: 'RESOURCE_GROUP', namespace_name: 'EVENT_NAME', name: 'HUB_NAME') do its('properties.messageRetentionInDays') { should cmp 4 } end ``` + ```ruby describe azure_event_hub_event_hub(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}') do its('properties.messageRetentionInDays') { should cmp 4 } @@ -88,19 +91,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect the resource to always exist +# If we expect the resource to always exist. -describe azure_event_hub_event_hub(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', name: 'myeventhub') do +describe azure_event_hub_event_hub(resource_group: 'RESOURCE_GROUP', namespace_name: 'EVENT_NAME', name: 'HUB_NAME') do it { should exist } end +``` + +### not_exists -# If we expect the resource not to exist +```ruby +# If we expect the resource not to exist. -describe azure_event_hub_event_hub(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', name: 'myeventhub') do +describe azure_event_hub_event_hub(resource_group: 'RESOURCE_GROUP', namespace_name: 'EVENT_NAME', name: 'HUB_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_event_hub_namespace.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_event_hub_namespace.md index c86d2cf099..cdd07dcc77 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_event_hub_namespace.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_event_hub_namespace.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_event_hub_namespace Resource" parent = "inspec/resources/azure" +++ -Use the `azure_event_hub_namespace` InSpec audit resource to test properties and configuration of an Azure Event Hub Namespace within a Resource Group. +Use the `azure_event_hub_namespace` InSpec audit resource to test the properties and configuration of an Azure Event Hub Namespace within a resource group. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `name` or the `resource_id` must be given as a parameter. +`resource_group` and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_event_hub_namespace(resource_group: 'my-rg', name: 'my-event-hub-ns') do +describe azure_event_hub_namespace(resource_group: 'RESOURCE_GROUP', name: 'EVENT_HUB_NAME') do it { should exist } end ``` + ```ruby describe azure_event_hub_namespace(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}') do it { should exist } @@ -37,18 +39,19 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `resourceGroupName`. +: Azure resource group where the targeted resource resides. `name` -: The unique name of the Event Hub Namespace. `namespaceName`. +: The unique name of the Event Hub Namespace. `namespace_name` : Alias for the `name` parameter. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` - `resource_group` and `namespace_name` @@ -56,22 +59,22 @@ Either one of the parameter sets can be provided for a valid query: ## Properties `properties.kafkaEnabled` -: Value that indicates whether Kafka is enabled for eventhub namespace. +: Value that indicates whether Kafka is enabled for Eventhub Namespace. -For parameters applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For parameters applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/eventhub/2017-04-01/namespaces/get#ehnamespace) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/eventhub/preview/namespaces/get?tabs=HTTP) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test If Kafka is Enabled for an Eventhub Namespace.** +### Test if Kafka is enabled for an Eventhub Namespace ```ruby -describe azure_event_hub_namespace(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns') do +describe azure_event_hub_namespace(resource_group: 'RESOURCE_GROUP', name: 'EVENT_HUB_NAME') do its('properties.kafkaEnabled') { should be true } end ``` + ```ruby describe azure_event_hub_namespace(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}') do its('properties.kafkaEnabled') { should be true } @@ -85,19 +88,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect the resource to always exist +# If we expect the resource to always exist. -describe azure_event_hub_namespace(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns') do +describe azure_event_hub_namespace(resource_group: 'RESOURCE_GROUP', name: 'EVENT_HUB_NAME') do it { should exist } end +``` + +### not_exists -# If we expect the resource not to exist +```ruby +# If we expect the resource not to exist. -describe azure_event_hub_namespace(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns') do +describe azure_event_hub_namespace(resource_group: 'RESOURCE_GROUP', name: 'EVENT_HUB_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_express_route_circuit.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_express_route_circuit.md index cb6e1c1119..1a0d9ad610 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_express_route_circuit.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_express_route_circuit.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_express_route_circuit Resource" parent = "inspec/resources/azure" +++ -Use the `azure_express_route_circuit` InSpec audit resource to test properties of an Azure ExpressRoute circuit resource. +Use the `azure_express_route_circuit` InSpec audit resource to test the properties of an Azure ExpressRoute circuit resource. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -41,7 +41,7 @@ end ## Parameters `resource_group` -: The Azure resource group that the targeted resource resides in. +: The Azure resource group where the targeted resource resides. `circuit_name` : The name of the ExpressRoute circuit. @@ -49,12 +49,12 @@ end `resource_id` : The resource ID of the ExpressRoute circuit. -Provide the `resource_group` and `name` parameters, or the `resource_id` for a valid query. +Provide the `resource_group` and `name` parameters, or the `resource_id` parameter for a valid query. ## Properties `resource_group` -: The name of the resource group that the ExpressRoute circuit resource resides in. +: The name of the resource group where the ExpressRoute circuit resource resides. `name` : The name of the ExpressRoute circuit. @@ -78,16 +78,16 @@ Provide the `resource_group` and `name` parameters, or the `resource_id` for a v : The name of the ExpressRoute circuit service provider name. `service_provider_provisioning_state` -: The service provider provisioning state of the ExpressRoute circuit resource. Possible values are, `NotProvisioned`, `Provisioning`, `Provisioned`, and `Deprovisioning`. +: The service provider provisioning state of the ExpressRoute circuit resource. Possible values are `NotProvisioned`, `Provisioning`, `Provisioned`, and `Deprovisioning`. `service_key` : The ServiceKey. `stag` -: The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +: The identifier of the circuit traffic. Outer tag for `QinQ` encapsulation. `global_reach_enabled` -: Flag denoting global reach status. `boolean`. +: Flag denoting global reach status. `boolean`. `allow_global_reach` : Flag to enable Global Reach on the ExpressRoute circuit. `boolean`. @@ -96,10 +96,10 @@ Provide the `resource_group` and `name` parameters, or the `resource_id` for a v : The GatewayManager Etag. `allow_classic_operations` -: Whether "Allow Classic Operations" is set to `true` or `false`. +: Whether `Allow Classic Operations` is set to `true` or `false`. `circuit_provisioning_state` -: The CircuitProvisioningState state of the resource. +: The `CircuitProvisioningState` state of the resource. `sku_name` : The name of the SKU. @@ -110,12 +110,11 @@ Provide the `resource_group` and `name` parameters, or the `resource_id` for a v `sku_family` : The family of the SKU. Possible values are: `UnlimitedData` and `MeteredData`. -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/expressroute/express-route-circuits/get) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/expressroute/express-route-circuits/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test the an ExpressRoute circuit resource has the correct type.** +### Test an ExpressRoute circuit resource has the correct type ```ruby describe azure_express_route_circuit(resource_group: 'RESOURCE_GROUP', circuit_name: 'EXPRESS_CIRCUIT_NAME') do @@ -123,7 +122,7 @@ describe azure_express_route_circuit(resource_group: 'RESOURCE_GROUP', circuit_n end ``` -**Test the an ExpressRoute circuit resource is in successful state.** +### Test an ExpressRoute circuit resource is in a successful state ```ruby describe azure_express_route_circuit(resource_group: 'RESOURCE_GROUP', circuit_name: 'EXPRESS_CIRCUIT_NAME') do @@ -131,7 +130,7 @@ describe azure_express_route_circuit(resource_group: 'RESOURCE_GROUP', circuit_n end ``` -**Test the location of an ExpressRoute circuit resource.** +### Test the location of an ExpressRoute circuit resource ```ruby describe azure_express_route_circuit(resource_group: 'RESOURCE_GROUP', circuit_name: 'EXPRESS_CIRCUIT_NAME') do @@ -146,18 +145,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a express circuit resource is found it will exist +# If an express circuit resource is found, it will exist. -describe azure_express_route_circuit(resource_group: 'MyResourceGroup', circuit_name: 'mycircuit_name') do +describe azure_express_route_circuit(resource_group: 'RESOURCE_GROUP', circuit_name: 'EXPRESS_CIRCUIT_NAME') do it { should exist } end +``` + +### not_exists + +```ruby +# If an express circuit resources that aren't found, will not exist. -# express circuit resources that aren't found will not exist -describe azure_express_route_circuit(resource_group: 'MyResourceGroup', circuit_name: 'DoesNotExist') do +describe azure_express_route_circuit(resource_group: 'RESOURCE_GROUP', circuit_name: 'DOESNOTEXIST') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_express_route_circuits.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_express_route_circuits.md index 4d6e833963..335401b9e2 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_express_route_circuits.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_express_route_circuits.md @@ -10,21 +10,18 @@ identifier = "inspec/resources/azure/azure_express_route_circuits Resource" parent = "inspec/resources/azure" +++ -Use the `azure_express_route_circuits` InSpec audit resource to test properties of Azure ExpressRoute circuits for a resource group. +Use the `azure_express_route_circuits` InSpec audit resource to test the properties of Azure ExpressRoute circuits for a resource group. ## Azure Rest API Version, Endpoint, And HTTP Client Parameters -This resource interacts with API versions supported by the resource provider. -The `api_version` can be defined as a resource parameter. -If not provided, the latest version will be used. -For more information, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md" >}}). +This resource interacts with API versions supported by the resource provider. The `api_version` can be defined as a resource parameter. +If not provided, the latest version is used. For more information, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md" >}}). -Unless defined, `azure_cloud` global endpoint, and default values for the HTTP client will be used. -For more information, refer to the resource pack [README](https://github.com/inspec/inspec-azure/blob/main/README.md). +Unless defined, `azure_cloud` global endpoint and default values for the HTTP client is used. For more information, refer to the resource pack [README](https://github.com/inspec/inspec-azure/blob/main/README.md). -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -39,7 +36,7 @@ end ## Parameters `resource_group` -: The Azure resource group that the targeted resources reside in. +: The Azure resource group where the targeted resources resides. ## Properties @@ -74,7 +71,7 @@ end : **Field**: `location` `service_provider_bandwidth_in_mbps` -: A list of the bandwidths in Mbps of the circuits when a circuit is provisioned on an ExpressRoutePort resource. +: A list of the bandwidths in Mbps of the circuits when a circuit is provisioned on an `ExpressRoutePort` resource. : **Field**: `service_provider_bandwidth_in_mbps` @@ -94,27 +91,27 @@ end : **Field**: `service_key` `stags` -: The identifiers of the circuit traffic. Outer tag for QinQ encapsulation. +: The identifiers of the circuit traffic. Outer tag for `QinQ` encapsulation. : **Field**: `stag` `global_reach_enabled` -: A list of The ExpressRoute circuit allowGlobalReachEnable. +: A list of the ExpressRoute circuit that denotes global reach enable status. : **Field**: `global_reach_enabled` `gateway_manager_etags` -: A list of The GatewayManager Etags in the ExpressRoute circuit resources. +: A list of the `GatewayManager` Etags in the ExpressRoute circuit resources. : **Field**: `gateway_manager_etag` `allow_classic_operations` -: A list of indicating whether "Allow Classic Operations" in the ExpressRoute circuit resources is set to `true` or `false`. +: A list of indicating whether `Allow Classic Operations` in the ExpressRoute circuit resources is set to `true` or `false`. : **Field**: `allow_classic_operation` `circuit_provisioning_states` -: A list of State of express circuitHostName creation. Valid values are: `Enabled` or `Disabled`. +: A list of State of express `circuitHostName` creation. Valid values are `Enabled` or `Disabled`. : **Field**: `circuit_provisioning_state` @@ -133,11 +130,17 @@ end : **Field**: `sku_family` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/expressroute/express-route-circuits/list?tabs=HTTP) for other properties available. ## Examples -**Ensure that an ExpressRoute circuit has a `Succeeded` provisioning state.** +### Ensure that an ExpressRoute circuit has a 'Succeeded' provisioning state ```ruby describe azure_express_route_circuits(resource_group: 'RESOURCE_GROUP') do @@ -145,7 +148,7 @@ describe azure_express_route_circuits(resource_group: 'RESOURCE_GROUP') do end ``` -**Test than an ExpressRoute circuit has a specific location.** +### Test than an ExpressRoute circuit has a specific location ```ruby describe azure_express_route_circuits(resource_group: 'RESOURCE_GROUP') do @@ -155,16 +158,23 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should exist if express_route_circuits are in the resource group +# Should exist if express_route_circuits are in the resource group. describe azure_express_route_circuits(resource_group: 'RESOURCE_GROUP') do it { should exist } end +``` + +### not_exists + +```ruby # Should not exist if no express_route_circuits are in the resource group describe azure_express_route_circuits(resource_group: 'RESOURCE_GROUP') do @@ -174,4 +184,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_express_route_providers.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_express_route_providers.md index 0c46977930..caac8501f3 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_express_route_providers.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_express_route_providers.md @@ -10,27 +10,31 @@ identifier = "inspec/resources/azure/azure_express_route_providers Resource" parent = "inspec/resources/azure" +++ -Use the `azure_express_route_providers` InSpec audit resource to test properties related to azure_express_route for a resource group or the entire subscription. +Use the `azure_express_route_providers` InSpec audit resource to test the properties related to azure_express_route for a resource group or the entire subscription. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_express_route_providers` resource block returns all Azure azure_express_route, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_express_route_providers` resource block returns all Azure azure_express_route, either within a resource group (if provided) or an entire Subscription. + ```ruby describe azure_express_route_providers do #... end ``` -or + +Or + ```ruby -describe azure_express_route_providers(resource_group: 'my-rg') do + +describe azure_express_route_providers(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -44,7 +48,7 @@ end ## Properties `names` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `name` @@ -64,7 +68,7 @@ end : **Field**: `tag` `provisioning_states` -: A list of status of request. +: A list of the status of the request. : **Field**: `provisioning_state` @@ -78,37 +82,41 @@ end : **Field**: `bandwidths` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test If Any azure_express_route Exist in the Resource Group.** +### Test if any azure_express_route exists in the resource group ```ruby -describe azure_express_route_providers(resource_group: 'MyResourceGroup') do +describe azure_express_route_providers(resource_group: 'RESOURCE_GROUP') do it { should exist } end describe azure_express_route_providers do it { should exist } end -``` -**Test that There are express_route that Includes a Certain String in their Names (Server Side Filtering via Generic Resource - Recommended) .** +``` + +### Test that there are express_route that includes a string in names (Server Side Filtering via Generic Resource - Recommended) ```ruby -describe azure_generic_resources(resource_group: 'MyResourceGroup') do +describe azure_generic_resources(resource_group: 'RESOURCE_GROUP') do it { should exist } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). - +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ```ruby -# Should not exist if no azure_express_route are in the resource group +# Should not exist if no azure_express_route is in the resource group. -describe azure_express_route_providers(resource_group: 'MyResourceGroup') do +describe azure_express_route_providers(resource_group: 'RESOURCE_GROUP') do its('provisioning_states') { should include('Succeeded') } its('peering_locations_list') { should include(["Melbourne", "Sydney"]) } its('bandwidths_offered_list') { should include('bandwidths_offered') } @@ -117,4 +125,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_generic_resource.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_generic_resource.md index edc552b21d..a28d453ce1 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_generic_resource.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_generic_resource.md @@ -10,50 +10,50 @@ identifier = "inspec/resources/azure/azure_generic_resource Resource" parent = "inspec/resources/azure" +++ -Use the `azure_generic_resource` Inspec audit resource to test any valid Azure resource available through Azure Resource Manager. +Use the `azure_generic_resource` Inspec audit resource to test any valid Azure resource available through Azure Resource Manager. -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax ```ruby -describe azure_generic_resource(resource_group: 'MyResourceGroup', name: 'MyResource') do +describe azure_generic_resource(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('property') { should eq 'value' } end ``` -where - -* Resource parameters are used to query Azure Resource Manager endpoint for the resource to be tested. -* `property` - This generic resource dynamically creates the properties on the fly based on the type of resource that has been targeted. -* `value` is the expected output from the chosen property. +> where +> +> - Resource parameters are used to query the Azure Resource Manager endpoint for the resource to be tested. +> - `property` - This generic resource dynamically creates the properties on the fly based on the resource type that has been targeted. +> - `value` - the expected output from the chosen property. ## Parameters The following parameters can be passed for targeting a specific Azure resource. `resource_group` -: Azure resource group that the targeted resource has been created in. `MyResourceGroup`. +: Azure resource group where the targeted resource has been created. `name` -: Name of the Azure resource to test. `MyResourceName`. +: Name of the Azure resource to test. `resource_provider` -: Azure resource provider of the resource to be tested. `Microsoft.Compute/virtualMachines`. +: Azure resource provider of the resource to be tested. `resource_path` -: Relative path to the resource if it is defined on another resource. Resource path of a subnet in a virtual network would be: `{virtualNetworkName}/subnets`. +: Relative path to the resource if it is defined on another resource. The resource path of a subnet in a virtual network would be: `{virtualNetworkName}/subnets`. `resource_id` -: Unique id of Azure resource to be tested. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}`. +: Unique ID of Azure resource to be tested. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}`. `resource_uri` : Azure REST API URI of the resource to be tested. This parameter should be used when a resource does not reside in a resource group. It requires `add_subscription_id` and `name` parameters to be provided together. `/providers/Microsoft.Authorization/policyDefinitions/`. `add_subscription_id` -: Indicates whether the `resource_uri` contains the subscription id. `true` or `false`. +: Indicates whether the `resource_uri` contains the subscription ID. `true` or `false`. `tag_name*` : Tag name defined on the Azure resource. `name`. @@ -62,11 +62,12 @@ The following parameters can be passed for targeting a specific Azure resource. : Tag value of the tag defined with the `tag_name`. `external_linux`. `api_version` -: API version to use when interrogating the resource. If not set or the provided api version is not supported by the resource provider then the latest version for the resource provider will be used. `2017-10-9`, `latest`, `default`. +: API version to use when interrogating the resource. If not set or the resource provider does not support the provided API version, then the latest version for the resource provider will be used. `2017-10-9`, `latest`, and `default`. * When resources are filtered by a tag name and value, the tags for each resource are not returned in the results. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` - `name` @@ -75,16 +76,17 @@ Either one of the parameter sets can be provided for a valid query: - `add_subscription_id`, `resource_uri` and `name` - `tag_name` and `tag_value` -Different parameter combinations can be tried. If it is not supported, either the InSpec resource or the Azure Rest API will raise an error. +Different parameter combinations can be tried. If it is not supported, the InSpec resource or the Azure Rest API will raise an error. -If the Azure Resource Manager endpoint returns multiple resources for a given query, this singular generic resource will fail. In that case, the [plural generic resource]({{< relref "azure_generic_resources.md" >}}) should be used. +If the Azure Resource Manager endpoint returns multiple resources for a given query, this singular generic resource will fail. In that case, the [plural generic resource]({{< relref "azure_generic_resources.md" >}}) should be used. ## Properties -The properties that can be tested are dependent on the Azure Resource that is tested. One way to see what properties can be tested is checking their API pages. For example for virtual machines, see [here](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get). -Also the [Azure Resources Portal](https://resources.azure.com) can be used to select the resource you are interested in and see what can be tested. +The properties that can be tested are dependent on the Azure Resource that is tested. One way to see what properties can be tested is by checking their API pages. For example, about virtual machines, see [here](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get). -The following properties are applicable to almost all resources. +Also, the [Azure Resources Portal](https://resources.azure.com) can be used to select the resource you are interested in and see what can be tested. + +The following properties apply to almost all resources. `id` : The unique resource identifier. @@ -104,14 +106,14 @@ The following properties are applicable to almost all resources. `properties` : The resource properties. -For more properties, refer to specific Azure documents for the resource being tested. +For more properties, refer to specific Azure documents for the tested resource. ## Examples -**Test Properties of a Virtual Machine and the Endpoint API Version.** +### Test properties of a virtual machine and the endpoint API version ```ruby -describe azure_generic_resource(resource_group: 'my_vms', name: 'my_linux_vm') do +describe azure_generic_resource(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('properties.storageProfile.osDisk.osType') { should cmp 'Linux' } its('properties.storageProfile.osDisk.createOption') { should cmp 'FromImage' } its('properties.storageProfile.osDisk.name') { should cmp 'linux-external-osdisk' } @@ -120,7 +122,8 @@ describe azure_generic_resource(resource_group: 'my_vms', name: 'my_linux_vm') d its('api_version_used_for_query_state') { should eq 'latest' } end ``` -**Test the API Version Used for the Query.** + +### Test to ensure that the API version is used for the Query ```ruby describe azure_generic_resource(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}', api_version: '2017-01-01') do @@ -128,60 +131,71 @@ describe azure_generic_resource(resource_id: '/subscriptions/{subscriptionId}/re its('api_version_used_for_query') { should eq '2017-01-01' } end ``` -**Test the Tags if Include Specific Values.** + +### Test to ensure if the tags include specific values ```ruby -describe azure_generic_resource(resource_group: 'my_vms', name: 'my_linux_vm') do +describe azure_generic_resource(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('tags') { should include(name: 'MyVM') } + **The tag key name can be tested in String or Symbol.** **regardless of the value.** **regardless of the value.** end ``` -**Test Properties of a Virtual Machine Resides in an Azure Dev Test Lab .** + +### Test properties of a virtual machine resides in an Azure Dev Test Lab ```ruby -describe azure_generic_resource(resource_provider: 'Microsoft.DevTestLab/labs', resource_path: '{labName}/virtualmachines', resource_group: 'my_group', name: 'my_VM') do +describe azure_generic_resource(resource_provider: 'Microsoft.DevTestLab/labs', resource_path: '{labName}/virtualmachines', resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('properties.userName') { should cmp 'admin' } its('properties.allowClaim') { should cmp false } end ``` -**Test a Resource Group .** + +### Test a resource group ```ruby -describe azure_generic_resource(add_subscription_id: true, resource_uri: '/resourcegroups/', name: 'my_group') do +describe azure_generic_resource(add_subscription_id: true, resource_uri: '/resourcegroups/', name: 'RESOURCE_GROUP') do it { should exist } its('tags') { should include(:owner) } its('tags') { should include(owner: 'John Doe') } end ``` -**Test a Policy Definition.** + +### Test a policy definition ```ruby -describe azure_generic_resource(add_subscription_id: true, resource_uri: 'providers/Microsoft.Authorization/policyDefinitions', name: 'my_policy') do +describe azure_generic_resource(add_subscription_id: true, resource_uri: 'providers/Microsoft.Authorization/policyDefinitions', name: 'POLICY') do it { should exist } its('properties.policyRule.then.effect') { should cmp 'deny' } its('properties.policyType') { should cmp 'Custom' } end ``` + For more examples, please see the [integration tests](/test/integration/verify/controls/azure_generic_resource.rb). ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist ```ruby -# Should not exist if there is no resource with a given name +# Should not exist if there is no resource with a given name. describe azure_generic_resource(name: 'fake_name') do it { should_not exist } end ``` + +### not_exists + ```ruby -# Should exist if there is one resource with a given name +# Should exist if there is one resource with a given name. describe azure_generic_resource(name: 'a_very_unique_name_within_subscription') do it { should exist } @@ -190,4 +204,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_generic_resources.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_generic_resources.md index f284d8d81a..ed62d2fad6 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_generic_resources.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_generic_resources.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_generic_resources Resource" parent = "inspec/resources/azure" +++ -Use the `azure_generic_resources` Inspec audit resource to test any valid Azure resources. +Use the `azure_generic_resources` Inspec audit resource to test any valid Azure resources. -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -This resource will interrogate all resource in your subscription available through Azure Resource Manager when initiated without a parameter. +This resource will interrogate all resources in your subscription available through Azure Resource Manager when initiated without a parameter. ```ruby describe azure_generic_resources do @@ -28,28 +28,27 @@ end ## Parameters -The following parameters can be passed for targeting Azure resources. -All of them are optional. +The following parameters can be passed for targeting Azure resources. All of them are optional. `resource_group` -: Azure resource group that the targeted resources have been created in. +: Azure resource group where the targeted resources have been created. : **Example**: `MyResourceGroup` `substring_of_resource_group` -: Substring of an Azure resource group name that the targeted resources have been created in. +: Substring of an Azure resource group name where the targeted resources have been created. -: **Example**: `My` +: **Example**: `RESOURCE_GROUP` `name` : Name of the Azure resources to test. -: **Example**: `MyVM` +: **Example**: `VM_NAME` `substring_of_name` -: Substring of a name of the Azure resources to test. +: Substring a name of the Azure resources to test. -: **Example**: `My ` +: **Example**: `NAME` `resource_provider` : Azure resource provider of the resources to be tested. @@ -72,17 +71,18 @@ All of them are optional. : **Example**: `/providers/Microsoft.Authorization/policyDefinitions/` `add_subscription_id` -: Indicates whether the `resource_uri` contains the subscription id. +: Indicates whether the `resource_uri` contains the subscription ID. : **Example**: `true` or `false` `filter_free_text` -: Filter expression for the endpoints supporting `$filter` parameter, eg. [Azure role assignments](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-list-rest). This can only be used with the `resource_uri` parameter. +: Filter expression for the endpoints supporting `$filter` parameter. For example, [Azure role assignments](https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-list-rest). This can only be used with the `resource_uri` parameter. : **Example**: `"atScope()"` * When resources are filtered by a tag name and value, the tags for each resource are not returned in the results. Either one of the parameter sets can be provided for a valid query: + - `resource_group` - `substring_of_resource_group` - `name` @@ -96,19 +96,19 @@ Either one of the parameter sets can be provided for a valid query: - `add_subscription_id` and `resource_uri` - `add_subscription_id`, `resource_uri` and `filter_free_text` -Different parameter combinations can be tried. If it is not supported either the InSpec resource or the Azure Rest API will raise an error. +Different parameter combinations can be tried. If it is not supported, the InSpec resource or the Azure Rest API will raise an error. -It is advised to use these parameter sets to narrow down the targeted resources at the server side, Azure Rest API, for a more computing resource efficient test. +It is advised to use these parameter sets to narrow down the targeted resources at the server side, Azure Rest API, for a more computing resource-efficient test. ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` `names` -: A list of the resource names that are unique within a resource group. +: A list of the unique resource names within a resource group. : **Field**: `name` @@ -123,7 +123,7 @@ It is advised to use these parameter sets to narrow down the targeted resources : **Field**: `type` `locations` -: A list of locations where resources are created in. +: A list of locations where resources are created. : **Field**: `location` @@ -133,7 +133,7 @@ It is advised to use these parameter sets to narrow down the targeted resources : **Field**: `created_time` `changed_times**` -: A list of changed times of the resources. +: A list of changing times of the resources. : **Field**: `changed_time` @@ -142,13 +142,17 @@ It is advised to use these parameter sets to narrow down the targeted resources : **Field**: `provisioning_state` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ** These properties are not available when `resource_uri` is used. ## Examples -**Test All Virtual Machines in Your Subscription.** +### Test all virtual machines in your subscription ```ruby describe azure_generic_resources(resource_provider: 'Microsoft.Compute/virtualMachines') do @@ -156,7 +160,8 @@ describe azure_generic_resources(resource_provider: 'Microsoft.Compute/virtualMa its('count') { should eq 43 } end ``` -**Test All Resources Regardless of Their Type and Resource Group with a Common String in Their Names (Server Side Filtering).** + +### Test all resources regardless of their type and resource group with a common string in names (Server Side Filtering) ```ruby azure_generic_resources(substring_of_name: 'project_a').ids.each do |id| @@ -165,71 +170,85 @@ azure_generic_resources(substring_of_name: 'project_a').ids.each do |id| its('location') { should eq 'eastus' } end end -``` -**Test All Resources Regardless of Their Type and Resource Group with a Common Tag `name:value` Pair (Server Side Filtering).** +``` + +### Test all resources regardless of their type and resource group with a common tag 'name:value' pair (Server Side Filtering) ```ruby -azure_generic_resources(tag_name: 'demo', tag_value: 'shutdown_at_10_pm').ids.each do |id| +azure_generic_resources(tag_name: 'demo', tag_value: 'shutdown_at_10_pm').ids.each do |id| describe azure_generic_resource(resource_id: id) do it { should exist } its('location') { should eq 'eastus' } end end -``` -**Filters the Results to Only Include Those that Match the Given Location (Client Side Filtering).** +``` + +### Filters the results to only include those that match the given location (Client Side Filtering) ```ruby describe azure_generic_resources.where(location: 'eastus') do it { should exist } end ``` -**Filters the Results to Only Include Those that Created within Last 24 Hours (Client Side Filtering).** + +### Filters the results to only include those that created within last 24 hours (Client Side Filtering) ```ruby describe azure_generic_resources.where{ created_time > Time.now - 86400 } do it { should exist } end ``` -**Test Policy Definitions.** + +### Test policy definitions ```ruby describe azure_generic_resources(add_subscription_id: true, resource_uri: 'providers/Microsoft.Authorization/policyDefinitions') do it { should exist } end ``` -**Filter Role Assignments via `filter_free_text`.** + +### Filter role assignments via 'filter_free_text' ```ruby describe azure_generic_resources(add_subscription_id: true, resource_uri: "providers/Microsoft.Authorization/roleAssignments", filter_free_text: "atScope()+and+assignedTo('{abcd1234-abcd-1234}')") do it { should exist } end ``` -Please see [here](https://github.com/inspec/inspec/blob/master/docs/dev/filtertable-usage.md) for more information on how to leverage FilterTable capabilities on plural resources. + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} For more examples, please see the [integration tests](/test/integration/verify/controls/azure_generic_resources.rb). ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist ```ruby -# Should not exist if there is no resource with a given resource group +# Should not exist if there is no resource with a given resource group. describe azure_generic_resources(resource_group: 'fake_group') do it { should_not exist } end ``` + +### not_exists + ```ruby -# Should exist if there is at least one resource +# Should exist if there is at least one resource. -describe azure_generic_resources(resource_group: 'MyResourceGroup') do +describe azure_generic_resources(resource_group: 'RESOURCE_GROUP') do it { should exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} - +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_generic_resource.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_generic_resource.md index e3bb2d7bce..6c78dd23e6 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_generic_resource.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_generic_resource.md @@ -14,41 +14,41 @@ Use the `azure_graph_generic_resource` Inspec audit resource to test any valid A ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax ```ruby -describe azure_graph_generic_resource(resource: 'resource', id: 'GUID', select: %w(attributes to be tested)) do +describe azure_graph_generic_resource(resource: 'RESOURCE', id: 'GUID', select: %w(attributes to be tested)) do its('property') { should eq 'value' } end ``` -where: - -- Resource parameters are used to query Azure Graph API endpoint for the resource to be tested. -- `property` - This generic resource dynamically creates the properties on the fly based on the property names provided with the `select` parameter. -- `value` is the expected output from the chosen property. +> where: +> +> - Resource parameters are used to query Azure Graph API endpoint for the resource to be tested. +> - `property` - This generic resource dynamically creates the properties on the fly based on the property names provided with the `select` parameter. +> - `value` is the expected output from the chosen property. ## Parameters The following parameters can be passed for targeting a specific Azure resource. `resource` -: Azure resource type that the targeted resource belongs to. For example, `users`. +: Azure resource type where the targeted resource belongs. For example, `users`. `id` : Globally unique ID of the targeted resource. For example, `jdoe@example.com`. `select` -: The list of query parameters defining which attributes that the resource will expose. If not provided then the predefined attributes will be returned from the API. For example, `['givenName', 'surname', 'department']`. +: The list of query parameters defining which attributes the resource will expose. If not provided, then the predefined attributes will be returned from the API. For example, `givenName`, `surname`, and `department`. `api_version` -: API version of the GRAPH API to use when interrogating the resource. If not set, then the predefined stable version will be used. For example, `v1.0` or `beta`. +: API version of the GRAPH API to use when interrogating the resource. If not set, then the predefined stable version will be used. For example, `v1.0`, or `beta`. ## Properties @@ -56,29 +56,37 @@ The properties that can be tested are entirely dependent on the Azure Resource t ## Examples -**Test properties of a user account.** +### Test properties of a user account ```ruby -describe azure_graph_generic_resource(resource: 'users', id: 'jdoe@contoso.com', select: %w{ surname givenName }) do +describe azure_graph_generic_resource(resource: 'USERS', id: 'jdoe@contoso.com', select: %w{ surname givenName }) do its('surname') { should cmp 'Doe' } its('givenName') { should cmp 'John' } end ``` -For more examples, please see the [integration tests](../../test/integration/verify/controls/azure_graph_generic_resource.rb). + +For more examples, please see the [integration tests](https://github.com/inspec/inspec-azure/blob/main/test/integration/verify/controls/azure_graph_generic_resource.rb). ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist ```ruby -# Should not exist if there is no resource with a given name +# Should not exist if there is no resource with a given name. describe azure_graph_generic_resource(resource: 'users', id: 'fake_id') do it { should_not exist } end -# Should exist if there is one resource with a given name +``` + +### not_exists + +```ruby +# Should exist if there is one resource with a given name. describe azure_graph_generic_resource(resource: 'users', id: 'valid_id') do it { should exist } @@ -88,4 +96,5 @@ end ## Azure Permissions Graph resources require specific privileges granted to your service principal. -Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. \ No newline at end of file + +Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_generic_resources.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_generic_resources.md index 5850100c06..01bb7994ed 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_generic_resources.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_generic_resources.md @@ -10,48 +10,48 @@ identifier = "inspec/resources/azure/azure_graph_generic_resources Resource" parent = "inspec/resources/azure" +++ -Use the `azure_graph_generic_resources` Inspec audit resource to test any valid Azure resource available through Microsoft Azure Graph API. +Use the `azure_graph_generic_resources` Inspec audit resource to test any valid Azure resource available through Microsoft Azure Graph API. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax ```ruby -describe azure_graph_generic_resources(resource: 'resource', filter: {starts_with_property_name: 'A'}, select: %w(properties to be tested)) do +describe azure_graph_generic_resources(resource: 'RESOURCE', filter: {starts_with_property_name: 'A'}, select: %w(properties to be tested)) do its('property') { should eq 'value' } end ``` -where - -- Resource parameters are used to query Azure Graph API endpoint for the resource to be tested. -- `property` - This generic resource dynamically creates the properties on the fly based on the type of resource that has been targeted and the parameters provided with the `select` parameter. -- `value` is the expected output from the chosen property. +> where +> +> - Resource parameters are used to query Azure Graph API endpoint for the resource to be tested. +> - `property` - This generic resource dynamically creates the properties on the fly based on the type of resource that has been targeted and the parameters provided with the `select` parameter. +> - `value` is the expected output from the chosen property. ## Parameters The following parameters can be passed for targeting specific Azure resources. `resource` -: Azure resource type that the targeted resource belongs to. This is the only **MANDATORY** parameter. For example, `users`. +: Azure resource type where the targeted resource belongs. This is the only **MANDATORY** parameter. For example, `users`. `filter` -: A hash containing the filtering options and their values. The `starts_with_` operator can be used for fuzzy string matching. Parameter names are in snake case. For example, `{ starts_with_given_name: 'J', starts_with_department: 'Core', country: 'United Kingdom', given_name: John}`. +: A hash containing the filtering options and their values. The `starts_with_` operator can be used for fuzzy string matching. Parameter names are in the snake case. For example, `{ starts_with_given_name: 'J', starts_with_department: 'Core', country: 'United Kingdom', given_name: John}`. `filter_free_text` -: [OData](https://www.odata.org/getting-started/basic-tutorial/) query string in double quotes, `"`. Property names are in camel case, refer to [Azure query parameters documentation](https://docs.microsoft.com/en-us/graph/query-parameters#filter-parameter) for more information. For example, `"startswith(displayName,'J') and surname eq 'Doe'"`. +: [OData](https://www.odata.org/getting-started/basic-tutorial/) query string in double quotes, `"`. Property names are in the camel case, refer to [Azure query parameters documentation](https://docs.microsoft.com/en-us/graph/query-parameters#filter-parameter) for more information. For example, `"startswith(displayName,'J') and surname eq 'Doe'"`. `select` -: A list of the query parameters defining which attributes that the resource will expose and to be tested. Property names are in camel case. If not provided then the predefined attributes will be returned from the API. For example, `['givenName', 'surname', 'department']`. +: A list of the query parameters defining the attributes the resource will expose and to be tested. Property names are in camel case. If not provided then the predefined attributes will be returned from the API. For example, `['givenName', 'surname', 'department']`. `api_version` -: API version of the Azure Graph API to use when interrogating the resource. If not set then the predefined stable version will be used. For example, `v1.0` or `beta`. +: API version of the Azure Graph API to use when interrogating the resource. If not set, then the predefined stable version will be used. For example, `v1.0` or `beta`. It is advised to use `filter` or `filter_free_text` to narrow down the targeted resources at the server side, Azure Graph API, for a more efficient test. @@ -59,79 +59,91 @@ It is advised to use `filter` or `filter_free_text` to narrow down the targeted Attributes will be created dynamically by pluralizing the name of the properties of the resources and converting them to `snake_case` form. -E.g., if the query parameters are `select: %w{ country department givenName }`, then the parameters will be: +For example, if the query parameters are `select: %w{ country department givenName }`, then the parameters will be: - `ids` (default) -- `countries` -- `departments` -- `given_names` +- `countries` +- `departments` +- `given_names` ### Filter Criteria -Returned resources can be filtered by their parameters provided with the `select` option or the default values returned from the API unless the `select` is used. +Returned resources can be filtered by their parameters provided with the `select` option, or the default values returned from the API unless the `select` is used. -E.g., if the query parameters are `select: %w{ country department givenName }`, then the filter criteria will be: +For example, if the query parameters are `select: %w{ country department givenName }`, then the filter criteria will be: - `id` (default) -- `country` -- `department` -- `givenName` +- `country` +- `department` +- `givenName` ## Examples -**Test a Selection of User Accounts.** +### Test a selection of user accounts ```ruby **Using filter parameter.** -describe azure_graph_generic_resources(resource: 'users', filter: { starts_with_given_name: 'J', starts_with_department: 'customer', country: 'United Kingdom' }, select: %w{ country userPrincipalName}) do +describe azure_graph_generic_resources(resource: 'USERS', filter: { starts_with_given_name: 'J', starts_with_department: 'customer', country: 'United Kingdom' }, select: %w{ country userPrincipalName}) do it { should exist } its('countries'.uniq) { should eq ['United Kingdom'] } end **Using filter_free_text parameter.** -describe azure_graph_generic_resources(resource: 'users', filter_free_text: "startswith(givenName,'J') and startswith(department,'customer') and country eq 'United States'", select: %w{ country userPrincipalName}) do +describe azure_graph_generic_resources(resource: 'USERS', filter_free_text: "startswith(givenName,'J') and startswith(department,'customer') and country eq 'United States'", select: %w{ country userPrincipalName}) do it { should exist } its('countries'.uniq) { should eq ['United States'] } end ``` -**Filter* the Results to Only Include Those that Match the Given Country (Client-Side Filtering is NOT Recommended).** +### Filter* the results to only include that match the given country (Client-Side Filtering is NOT Recommended) ```ruby - describe azure_graph_generic_resources(resource: 'users', select: %w{ country }).where(country: 'United Kingdom') do + describe azure_graph_generic_resources(resource: 'USERS', select: %w{ country }).where(country: 'United Kingdom') do it { should exist } end ``` -*For information on how to use filter criteria on plural resources refer to [FilterTable usage](https://github.com/inspec/inspec/blob/master/dev-docs/filtertable-usage.md). Please note that instead of client side filtering with `where`, it is much more efficient to use server side filtering at Azure Graph API with `filter` or `filter_free_text` at resource creation as described in previous examples. + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} **Test `given_names` Parameter.** ```ruby -azure_graph_generic_resources(resource: 'users', filter: { starts_with_given_name: 'J' }, select: %w{ givenName }).given_names.each do |name| +azure_graph_generic_resources(resource: 'USERS', filter: { starts_with_given_name: 'J' }, select: %w{ givenName }).given_names.each do |name| describe name do it { should start_with('J') } - end -end + end +end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist ```ruby -# Should not exist if there is no resource with a given name +# Should not exist if there is no resource with a given name. -describe azure_graph_generic_resources(resource: 'users', filter: { given_name: 'fake_name'}, select: %w{ givenName }) do +describe azure_graph_generic_resources(resource: 'USERS', filter: { given_name: 'fake_name'}, select: %w{ givenName }) do it { should_not exist } end +``` + +### not_exists -# Should exist if there is at least one resource with a given name +```ruby -describe azure_graph_generic_resources(resource: 'users', filter: { given_name: 'valid_name'}, select: %w{ givenName }) do +# Should exist if there is at least one resource with a given name. + +describe azure_graph_generic_resources(resource: 'USERS', filter: { given_name: 'valid_name'}, select: %w{ givenName }) do it { should exist } end ``` @@ -139,4 +151,5 @@ end ## Azure Permissions Graph resources require specific privileges granted to your service principal. -Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. \ No newline at end of file + +Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_user.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_user.md index b5099f7717..8ad466979b 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_user.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_user.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_graph_user Resource" parent = "inspec/resources/azure" +++ -Use the `azure_graph_user` InSpec audit resource to test properties of an Azure Active Directory user within a Tenant. +Use the `azure_graph_user` InSpec audit resource to test the properties of an Azure Active Directory user within a Tenant. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -43,9 +43,10 @@ Either one of the following parameters is mandatory. : **Example**: `abcd-1234-efabc-5678` `user_id` -: Globally unique identifier. (For backward compatibility.). +: Globally unique identifier (For backward compatibility). : **Example**: `abcd-1234-efabc-5678` + ## Properties `id` @@ -116,14 +117,15 @@ Either one of the following parameters is mandatory. ## Examples -**Test If an Active Directory User Account is Referenced with a Valid ID.** +### Test if an Active Directory user account is referenced with a valid ID ```ruby describe azure_graph_user(id: 'someValidId') it { should exist } end ``` -**Test If an Active Directory User Account is Referenced with an Invalid ID.** + +### Test if an Active Directory user Account is referenced with an invalid ID ```ruby describe azure_graph_user(id: 'someInvalidId') @@ -133,7 +135,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists @@ -146,4 +150,4 @@ end ## Azure Permissions Graph resources require specific privileges granted to your service principal. -Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. \ No newline at end of file +Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_users.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_users.md index f126d9a02c..5e4b4ee661 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_users.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_graph_users.md @@ -10,19 +10,20 @@ identifier = "inspec/resources/azure/azure_graph_users Resource" parent = "inspec/resources/azure" +++ -Use the `azure_graph_users` InSpec audit resource to test properties of some or all Azure Active Directory users within a Tenant. +Use the `azure_graph_users` InSpec audit resource to test the properties of some or all Azure Active Directory users within a Tenant. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_graph_users` resource block returns all Azure Active Directory user accounts contained within the configured Tenant and then tests that group of users. +An `azure_graph_users` resource block returns all Azure Active Directory user accounts within the configured Tenant and then tests that group of users. + ```ruby describe azure_graph_users do #... @@ -34,12 +35,12 @@ end The following parameters can be passed for targeting specific users. `filter` -: A hash containing the filtering options and their values. The `starts_with_` operator can be used for fuzzy string matching. Parameter names are in snake_case. +: A hash containing the filtering options and their values. The `starts_with_` operator can be used for fuzzy string matching. Parameter names are in the snake case. : **Example**: `{ starts_with_given_name: 'J', starts_with_department: 'Core', country: 'United Kingdom', given_name: John}` `filter_free_text` -: [OData](https://www.odata.org/getting-started/basic-tutorial/) query string in double quotes, `"`. Property names are in camelcase, refer to [here](https://docs.microsoft.com/en-us/graph/query-parameters#filter-parameter) for more information. +: [OData](https://www.odata.org/getting-started/basic-tutorial/) query string in double quotes, `"`. Property names are in the camel case. Refer to [here](https://docs.microsoft.com/en-us/graph/query-parameters#filter-parameter) for more information. : **Example**: `"startswith(displayName,'J') and surname eq 'Doe'"` or `"userType eq 'Guest'"` @@ -53,7 +54,7 @@ It is advised to use these parameters to narrow down the targeted resources at t : **Field**: `id` `object_ids` -: The unique identifiers of users. This is for backward compatibility, use `ids` instead. +: The unique identifiers of users. This is for backward compatibility. Use `ids` instead. : **Field**: `id` @@ -78,50 +79,59 @@ It is advised to use these parameters to narrow down the targeted resources at t : **Field**: `mail` `user_types` -: The user types of users, e.g.; `Member`, `Guest`. +: The user types of users. For example, `Member`, `Guest`. : **Field**: `userType` `user_principal_names` -: The user principal names of users, e.g.; `jdoe@contoso.com`. +: The user principal names of users. For example, `jdoe@contoso.com`. : **Field**: `userPrincipalName` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples The following examples show how to use this InSpec audit resource. -**Check Users with Some Filtering Parameters Applied at Server Side (Using `filter`).** +### Check users with some filtering parameters applied at server side (Using 'filter') ```ruby describe azure_graph_users(filter: {given_name: 'John', starts_with_department: 'Customer'}) do it { should exist } end -``` -**Check Users with Some Filtering Parameters Applied at Server Side (Using `filter_free_text`).** +``` + +### Check users with some filtering parameters applied at server side (Using 'filter_free_text') ```ruby describe azure_graph_users(filter_free_text: "startswith(givenName,'J') and startswith(department,'customer') and country eq 'United States'") do it { should exist } end ``` -**Ensure There are No Guest Accounts Active (Client Side Filtering).** + +### Ensure there are no guest accounts active (Client Side Filtering) ```ruby describe azure_graph_users.guest_accounts do it { should_not exist } end -``` +``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby describe azure_graph_users do it { should exist } diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hdinsight_cluster.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hdinsight_cluster.md index 7d5f1b22b8..798487a43b 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hdinsight_cluster.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hdinsight_cluster.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_hdinsight_cluster Resource" parent = "inspec/resources/azure" +++ -Use the `azure_hdinsight_cluster` InSpec audit resource to test properties of an Azure HDInsight Cluster. +Use the `azure_hdinsight_cluster` InSpec audit resource to test the properties of an Azure HDInsight Cluster. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_hdinsight_cluster` resource block identifies a HDInsight Cluster by `name` and `resource_group` or the `resource_id`. +An `azure_hdinsight_cluster` resource block identifies a HDInsight Cluster by `name` and `resource_group`, or the `resource_id`. + ```ruby -describe azure_hdinsight_cluster(resource_group: 'example', name: 'ClusterName') do +describe azure_hdinsight_cluster(resource_group: 'RESOURCE_GROUP', name: 'CLUSTER_NAME') do it { should exist } end ``` + ```ruby describe azure_hdinsight_cluster(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}') do it { should exist } @@ -37,15 +39,16 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `resourceGroupName`. +: Azure resource group where the targeted resource resides. `name` -: The unique name of the cluster. `clusterName`. +: The unique name of the cluster. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` @@ -54,33 +57,35 @@ Either one of the parameter sets can be provided for a valid query: `properties.clusterVersion` : The version of the cluster. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/hdinsight/clusters/get) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/hdinsight/2021-06-01/clusters/get?tabs=HTTP) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test that a Specified HDInsight Cluster is Successfully Provisioned.** +### Test that a specified HDInsight Cluster is successfully provisioned ```ruby -describe azure_hdinsight_cluster(resource_group: 'example', name: 'ClusterName') do +describe azure_hdinsight_cluster(resource_group: 'RESOURCE_GROUP', name: 'CLUSTER_NAME') do its('properties.provisioningState') { should cmp 'Succeeded' } end ``` + ```ruby describe azure_hdinsight_cluster(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}') do its('properties.provisioningState') { should cmp 'Succeeded' } end ``` -**Test the Version of a HDInsight Cluster.** + +### Test the version of an HDInsight Cluster ```ruby -describe azure_hdinsight_cluster(resource_group: 'example', name: 'ClusterName') do +describe azure_hdinsight_cluster(resource_group: 'RESOURCE_GROUP', name: 'CLUSTER_NAME') do its('properties.clusterVersion') { should cmp '4.0' } end ``` -See [integration tests](../../test/integration/verify/controls/azurerm_hdinsight_cluster.rb) for more examples. + +See [integration tests](https://github.com/inspec/inspec-azure/blob/main/test/integration/verify/controls/azure_hdinsight_cluster.rb) for more examples. ## Matchers @@ -89,19 +94,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect the resource to always exist +# If we expect the resource to always exist. -describe azure_hdinsight_cluster(resource_group: 'example', name: 'ClusterName') do +describe azure_hdinsight_cluster(resource_group: 'RESOURCE_GROUP', name: 'CLUSTER_NAME') do it { should exist } end +``` -# If we expect the resource not to exist +### not_exists + +```ruby +# If we expect the resource not to exist. -describe azure_hdinsight_cluster(resource_group: 'example', name: 'ClusterName') do +describe azure_hdinsight_cluster(resource_group: 'RESOURCE_GROUP', name: 'CLUSTER_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_asc_operation.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_asc_operation.md new file mode 100644 index 0000000000..2f6d78efe1 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_asc_operation.md @@ -0,0 +1,108 @@ ++++ +title = "azure_hpc_asc_operation Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_hpc_asc_operation" +identifier = "inspec/resources/azure/azure_hpc_asc_operation Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_hpc_asc_operation` InSpec audit resource to test the properties related to an Azure HPC ASC Operation. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +`name`, `cache_name`, and `resource_group` are required parameters. + +```ruby +describe azure_hpc_asc_operation(location: 'LOCATION', operation_id: 'OPERATION_ID') do + it { should exist } + its('type') { should eq 'Microsoft.StorageCache/Cache/StorageTarget' } + its('location') { should eq 'East US' } +end +``` + +```ruby +describe azure_hpc_asc_operation(location: 'LOCATION', operation_id: 'OPERATION_ID') do + it { should exist } +end +``` + +## Parameters + +`location` _(required)_ +: The name of the region used to look up the operation. + +`operation_id` _(required)_ +: The operation ID that uniquely identifies the asynchronous operation. + +## Properties + +`id` +: The operation ID. + +`name` +: The operation name. + +`startTime` +: The start time of the operation. + +`status` +: The status of the operation. + +`endTime` +: The end time of the operation. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/storagecache/asc-operations/get#ascoperation) for other properties available. + +## Examples + +### Test that the HPC ASC operation is succeeded + +```ruby +describe azure_hpc_asc_operation(location: 'LOCATION', operation_id: 'OPERATION_ID') do + its('status') { should eq 'Succeeded' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If an HPC ASC Operation is found, it will exist. + +describe azure_hpc_asc_operation(location: 'LOCATION', operation_id: 'OPERATION_ID') do + it { should exist } +end +``` + +### not_exists + +```ruby +# If an HPC ASC Operation is not found, it will not exist. + +describe azure_hpc_asc_operation(location: 'LOCATION', operation_id: 'OPERATION_ID') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_cache.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_cache.md new file mode 100644 index 0000000000..d86191714d --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_cache.md @@ -0,0 +1,117 @@ ++++ +title = "azure_hpc_cache Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_hpc_cache" +identifier = "inspec/resources/azure/azure_hpc_cache Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_hpc_cache` InSpec audit resource to test the properties related to an Azure HPC Cache. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +`name`, `cache_name`, and `resource_group` are required parameters. + +```ruby +describe azure_hpc_cache(resource_group: 'RESOURCE_GROUP', name: 'HPC_CACHE_NAME') do + it { should exist } + its('type') { should eq 'Microsoft.StorageCache/Cache' } + its('location') { should eq 'East US' } +end +``` + +```ruby +describe azure_hpc_cache(resource_group: 'RESOURCE_GROUP', name: 'HPC_CACHE_NAME') do + it { should exist } +end +``` + +## Parameters + +`name` _(required)_ +: Name of the Azure HPC Cache to test. + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`id` +: Resource ID of the HPC Cache. + +`name` +: Name of the HPC Cache. + +`type` +: Type of the HPC Cache, `Microsoft.StorageCache/Cache`. + +`location` +: Region name string. + +`properties` +: The properties of the HPC Cache. + +`properties.cacheSizeGB` +: The size of this HPC Cache (in GB). + +`properties.subnet` +: The subnet used for the HPC Cache. + +`properties.health` +: Health of the HPC Cache. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/storagecache/caches/get#cache) for other properties available. + +## Examples + +### Test that the HPC Cache is provisioned + +```ruby +describe azure_hpc_cache(resource_group: 'RESOURCE_GROUP', name: 'HPC_CACHE_NAME') do + its('properties.provisioningState') { should eq 'Succeeded' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If an HPC Cache is found, it will exist. + +describe azure_hpc_cache(resource_group: 'RESOURCE_GROUP', name: 'HPC_CACHE_NAME') do + it { should exist } +end +``` + +### not_exists + +```ruby +# If an HPC Cache is not found, it will not exist. + +describe azure_hpc_cache(resource_group: 'RESOURCE_GROUP', name: 'HPC_CACHE_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_cache_skus.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_cache_skus.md new file mode 100644 index 0000000000..6b626a6d36 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_cache_skus.md @@ -0,0 +1,99 @@ ++++ +title = "azure_hpc_cache_skus Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_hpc_cache_skus" +identifier = "inspec/resources/azure/azure_hpc_cache_skus Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_hpc_cache_skus` InSpec audit resource to test the properties related to all Azure HPC Cache SKUs. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_hpc_cache_skus` resource block returns all Azure HPC Cache SKUs. + +```ruby +describe azure_hpc_cache_skus do + #... +end +``` + +## Parameters + +## Properties + +`resourceTypes` +: A resource types list where the SKU applies. + +**Field**: `resourceType` + +`names` +: A list of SKU names. + +**Field**: `name` + +`sizes` +: A list of the SKU sizes. + +**Field**: `size` + +`tiers` +: A tiers list of VM in a scale set. + +**Field**: `tier` + +`kind` +: The supported kind list of resources. + +**Field**: `kind` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Ensure that there are Standard tier HPC Cache SKUs + +```ruby +describe azure_hpc_cache_skus.where(tier: 'STANDARD') do + it { should exist } +end +``` + +## Matchers + +This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). + +### exists + +```ruby +# Should not exist if no HPC Cache SKUs are present. + +describe azure_hpc_cache_skus do + it { should_not exist } +end +# Should exist if the filter returns at least one HPC Cache SKUs. + +describe azure_hpc_cache_skus do + it { should exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_caches.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_caches.md new file mode 100644 index 0000000000..94f66b4079 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_caches.md @@ -0,0 +1,129 @@ ++++ +title = "azure_hpc_caches Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_hpc_caches" +identifier = "inspec/resources/azure/azure_hpc_caches Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_hpc_caches` InSpec audit resource to test the properties related to all Azure HPC Caches. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_hpc_caches` resource block returns all Azure HPC Caches. + +```ruby +describe azure_hpc_caches do + #... +end +``` + +## Parameters + +`resource_group` _(optional)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`ids` +: A list of resource IDs. + +**Field**: `id` + +`names` +: A list of HPC Cache names. + +**Field**: `name` + +`types` +: A list of the HPC Cache types. + +**Field**: `type` + +`properties` +: A list of Properties for all the HPC Caches. + +**Field**: `properties` + +`locations` +: A list of the resource locations. + +**Field**: `location` + +`cacheSizeGBs` +: A list of the sizes of the HPC Cache. + +**Field**: `cacheSizeGB` + +`subnets` +: A list of subnets used for the HPC Cache. + +**Field**: `subnet` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Loop through HPC Caches by their names + +```ruby +azure_hpc_caches.names.each do |name| + describe azure_hpc_cache(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME', name: name) do + it { should exist } + end +end +``` + +### Test to ensure that there are provisioned HPC Caches + +```ruby +describe azure_hpc_caches.where(provisioningState: 'SUCCEEDED') do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no HPC Caches are present. + +describe azure_hpc_caches do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one HPC Caches. + +describe azure_hpc_caches do + it { should exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_storage_target.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_storage_target.md new file mode 100644 index 0000000000..64cbe10b68 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_storage_target.md @@ -0,0 +1,120 @@ ++++ +title = "azure_hpc_storage_target Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_hpc_storage_target" +identifier = "inspec/resources/azure/azure_hpc_storage_target Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_hpc_storage_target` InSpec audit resource to test the properties related to an Azure HPC Storage Target. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +`name`, `cache_name`, and `resource_group` are required parameters. + +```ruby +describe azure_hpc_storage_target(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME', name: 'HPC_STORAGE_TARGET_NAME') do + it { should exist } + its('type') { should eq 'Microsoft.StorageCache/Cache/StorageTarget' } + its('location') { should eq 'East US' } +end +``` + +```ruby +describe azure_hpc_storage_target(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME', name: 'HPC_STORAGE_TARGET_NAME') do + it { should exist } +end +``` + +## Parameters + +`name` _(required)_ +: Name of the Azure HPC Storage Targets to test. + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +`cache_name` _(required)_ +: Azure HPC Cache name. + +## Properties + +`id` +: Resource ID of the Storage Target. + +`name` +: Name of the Storage Target. + +`type` +: Resource type. + +`location` +: Region name string. + +`properties` +: The properties of the HPC Storage Target. + +`properties.blobNfs` +: The properties when the **targetType** is `blobNfs`. + +`properties.state` +: The storage target operational state. + +`properties.nfs3` +: Properties when the **targetType** is `nfs3`. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/storagecache/storage-targets/get#storagetarget) for other properties available. + +## Examples + +### Test that the HPC Storage Target is ready + +```ruby +describe azure_hpc_storage_target(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME', name: 'HPC_STORAGE_TARGET_NAME') do + its('properties.state') { should eq 'Ready' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If an HPC Storage Target is found, it will exist. + +describe azure_hpc_storage_target(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME', name: 'HPC_STORAGE_TARGET_NAME') do + it { should exist } + +``` + +### not_exists + +```ruby +# if HPC Storage Target is not found, it will not exist. + +describe azure_hpc_storage_target(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME', name: 'HPC_STORAGE_TARGET_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_storage_targets.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_storage_targets.md new file mode 100644 index 0000000000..efa6c3f0f8 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_hpc_storage_targets.md @@ -0,0 +1,132 @@ ++++ +title = "azure_hpc_storage_targets Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_hpc_storage_targets" +identifier = "inspec/resources/azure/azure_hpc_storage_targets Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_hpc_storage_targets` InSpec audit resource to test the properties related to all Azure HPC Storage Targets. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_hpc_storage_targets` resource block returns all Azure HPC Storage Targets. + +```ruby +describe azure_hpc_storage_targets(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME') do + #... +end +``` + +## Parameters + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +`cache_name` _(required)_ +: Azure HPC Cache name. + +## Properties + +`ids` +: A list of resource IDs. + +: **Field**: `id` + +`names` +: A list of resource Names. + +: **Field**: `name` + +`types` +: A list of the resource types. + +: **Field**: `type` + +`properties` +: A list of Properties for all the HPC Storage Targets. + +: **Field**: `properties` + +`locations` +: A list of the resource locations. + +: **Field**: `location` + +`targetTypes` +: A list of the types of storage target. + +: **Field**: `targetType` + +`states` +: A list of the operational state of the storage target. + +: **Field**: `provisioningState` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Loop through HPC Storage Targets by their names + +```ruby +azure_hpc_storage_targets(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME').names.each do |name| + describe azure_hpc_storage_target(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME', name: name) do + it { should exist } + end +end +``` + +### Test that there are HPC Storage Targets that are ready + +```ruby +describe azure_hpc_storage_targets(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME').where(state: 'Ready') do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no HPC Storage Targets are present. + +describe azure_hpc_storage_targets(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one HPC Storage Targets. + +describe azure_hpc_storage_targets(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME') do + it { should exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_iothub.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_iothub.md index 8083c89b2d..b5f9f473f1 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_iothub.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_iothub.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_iothub Resource" parent = "inspec/resources/azure" +++ -Use the `azure_iothub` InSpec audit resource to test properties of an Azure IoT hub within a Resource Group. +Use the `azure_iothub` InSpec audit resource to test the properties of an Azure IoT hub within a resource group. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `name` or the `resource_id` must be given as a parameter. +`resource_group` and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_iothub(resource_group: 'my-rg', name: 'my-iot-hub') do +describe azure_iothub(resource_group: 'RESOURCE_GROUP', name: 'IoT_NAME') do it { should exist } end ``` + ```ruby describe azure_iothub(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}') do it { should exist } @@ -37,18 +39,19 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: The unique name of the IoT hub. `resourceName`. +: The unique name of the IoT hub. `resource_name` : Alias for the `name` parameter. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` - `resource_group` and `resource_name` @@ -58,20 +61,20 @@ Either one of the parameter sets can be provided for a valid query: `sku` : The SKU of the resource with [these](https://docs.microsoft.com/en-us/rest/api/iothub/iothubresource/get#iothubskuinfo) properties. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/iothub/iothubresource/get#iothubdescription) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/iothub/iothubresource/get#iothubdescription) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test if File Upload Notifications are Enabled.** +### Test if file upload notifications are enabled ```ruby -describe azure_iothub(resource_group: 'my-rg', name: 'my-iot-hub') do +describe azure_iothub(resource_group: 'RESOURCE_GROUP', name: 'IoT_NAME') do its('properties.enableFileUploadNotifications') { should cmp true } end ``` + ```ruby describe azure_iothub(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}') do its('properties.enableFileUploadNotifications') { should cmp true } @@ -85,19 +88,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect the resource to always exist +# If we expect the resource to always exist. -describe azure_iothub(resource_group: 'my-rg', name: 'my-iot-hub') do +describe azure_iothub(resource_group: 'RESOURCE_GROUP', name: 'IoT_NAME') do it { should exist } end +``` + +### not_exists -# If we expect the resource to never exist +```ruby +# If we expect the resource to never exist. -describe azure_iothub(resource_group: 'my-rg', name: 'my-iot-hub') do +describe azure_iothub(resource_group: 'RESOURCE_GROUP', name: 'IoT_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_iothub_event_hub_consumer_group.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_iothub_event_hub_consumer_group.md index 6af58f6242..9e4cdba230 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_iothub_event_hub_consumer_group.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_iothub_event_hub_consumer_group.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_iothub_event_hub_consumer_group Resou parent = "inspec/resources/azure" +++ -Use the `azure_iothub_event_hub_consumer_group` InSpec audit resource to test properties and configuration of an Azure IoT Hub Event Hub Consumer Group within a Resource Group. +Use the `azure_iothub_event_hub_consumer_group` InSpec audit resource to test the properties and configuration of an Azure IoT Hub Event Hub Consumer Group within a resource group. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group`, `resource_name`, `event_hub_endpoint` and `name` or the `resource_id` must be given as a parameter. +`resource_group`, `resource_name`, `event_hub_endpoint`, and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_iothub_event_hub_consumer_group(resource_group: 'my-rg', resource_name: 'my-iot-hub', event_hub_endpoint: 'myeventhub', name: 'my-consumer-group') do +describe azure_iothub_event_hub_consumer_group(resource_group: 'RESOURCE_GROUP', resource_name: 'IoT_NAME', event_hub_endpoint: 'EVENT_HUB_NAME', name: 'CONSUMER_GROUP') do it { should exist } end ``` + ```ruby describe azure_iothub_event_hub_consumer_group(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}') do it { should exist } @@ -37,16 +39,16 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `resource_name` -: The name of the IoT hub. `my-iot-hub`. +: The name of the IoT hub. `event_hub_endpoint` -: The name of the Event Hub-compatible endpoint in the IoT hub. `eventHubEndpointName`. +: The name of the Event Hub-compatible endpoint in the IoT hub. `name` -: The name of the consumer group to retrieve. `my-consumer-group`. +: The name of the consumer group to retrieve. `consumer_group` : Alias for the `name` parameter. @@ -55,6 +57,7 @@ end : The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}`. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group`, `resource_name`, `event_hub_endpoint` and `name` - `resource_group`, `resource_name`, `event_hub_endpoint` and `consumer_group` @@ -64,23 +67,23 @@ Either one of the parameter sets can be provided for a valid query: `name` : The Event Hub-compatible consumer group name. -For properties applicable to all resources, such as `type`, `tags`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `tags`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/iothub/iothubresource/geteventhubconsumergroup#eventhubconsumergroupinfo) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/iothub/iothubresource/geteventhubconsumergroup#eventhubconsumergroupinfo) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test the Name of a Resource.** +### Test the resource name ```ruby -describe azure_iothub_event_hub_consumer_group(resource_group: 'my-rg', resource_name: 'my-iot-hub', event_hub_endpoint: 'myeventhub', name: 'my-consumer-group') do - its('name') { should cmp 'my-consumer-group' } +describe azure_iothub_event_hub_consumer_group(resource_group: 'RESOURCE_GROUP', resource_name: 'IoT_NAME', event_hub_endpoint: 'EVENT_HUB_NAME', name: 'CONSUMER_GROUP') do + its('name') { should cmp 'CONSUMER_GROUP' } end ``` + ```ruby describe azure_iothub_event_hub_consumer_group(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}') do - its('name') { should cmp 'my-consumer-group' } + its('name') { should cmp 'CONSUMER_GROUP' } end ``` @@ -91,19 +94,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect the resource to always exist +# If we expect the resource to always exist. -describe azure_iothub_event_hub_consumer_group(resource_group: 'my-rg', resource_name: 'my-iot-hub', event_hub_endpoint: 'myeventhub', name: 'my-consumer-group') do +describe azure_iothub_event_hub_consumer_group(resource_group: 'RESOURCE_GROUP', resource_name: 'IoT_NAME', event_hub_endpoint: 'EVENT_HUB_NAME', name: 'CONSUMER_GROUP') do it { should exist } end +``` + +### not_exists -# If we expect the resource to never exist +```ruby +# If we expect the resource to never exist. -describe azure_iothub_event_hub_consumer_group(resource_group: 'my-rg', resource_name: 'my-iot-hub', event_hub_endpoint: 'myeventhub', name: 'my-consumer-group') do +describe azure_iothub_event_hub_consumer_group(resource_group: 'RESOURCE_GROUP', resource_name: 'IoT_NAME', event_hub_endpoint: 'EVENT_HUB_NAME', name: 'CONSUMER_GROUP') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_iothub_event_hub_consumer_groups.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_iothub_event_hub_consumer_groups.md index db395802a9..51d9a269ae 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_iothub_event_hub_consumer_groups.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_iothub_event_hub_consumer_groups.md @@ -10,22 +10,23 @@ identifier = "inspec/resources/azure/azure_iothub_event_hub_consumer_groups Reso parent = "inspec/resources/azure" +++ -Use the `azure_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. +Use the `azure_iothub_event_hub_consumer_groups` InSpec audit resource to test the properties and configuration of an Azure IoT Hub Event Hub Consumer Groups within a resource group. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -The `resource_group`, `resource_name` and `event_hub_endpoint` must be given as a parameter. +The `resource_group`, `resource_name`, and `event_hub_endpoint` are required parameters. + ```ruby -describe azure_iothub_event_hub_consumer_groups(resource_group: 'my-rg', resource_name: 'my-iot-hub', event_hub_endpoint: 'myeventhub') do - its('names') { should include 'my-consumer-group'} +describe azure_iothub_event_hub_consumer_groups(resource_group: 'RESOURCE_GROUP', resource_name: 'IoT_NAME', event_hub_endpoint: 'EVENT_HUB_NAME') do + its('names') { should include 'CONSUMER_GROUP'} its('types') { should include 'Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups' } end ``` @@ -33,18 +34,18 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `resource_name` -: The name of the IoT hub. `my-iot-hub`. +: The name of the IoT hub. `event_hub_endpoint` -: The name of the Event Hub-compatible endpoint in the IoT hub. `eventHubEndpointName`. +: The name of the Event Hub-compatible endpoint in the IoT hub. ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -78,35 +79,40 @@ end : **Field**: `etag` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check If a Specific Consumer Group Exists.** +### Check if a specific consumer group exists ```ruby -describe azure_iothub_event_hub_consumer_groups(resource_group: 'my-rg', resource_name: 'my-iot-hub', event_hub_endpoint: 'myeventhub') do - its('names') { should include('my_consumer_group') } +describe azure_iothub_event_hub_consumer_groups(resource_group: 'RESOURCE_GROUP', resource_name: 'IoT_NAME', event_hub_endpoint: 'EVENT_HUB_NAME') do + its('names') { should include('CONSUMER_GROUP') } end ``` -**exists.** +### exists + +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. ```ruby -**If we expect at least one resource to exists on a specified endpoint.** +**If we expect at least one resource to exist on a specified endpoint.** -describe azure_iothub_event_hub_consumer_groups(resource_group: 'my-rg', resource_name: 'my-iot-hub', event_hub_endpoint: 'myeventhub') do +describe azure_iothub_event_hub_consumer_groups(resource_group: 'RESOURCE_GROUP', resource_name: 'IoT_NAME', event_hub_endpoint: 'EVENT_HUB_NAME') do it { should exist } end -**If we expect not to exist any consumer groups on a specified endpoint.** +**If we expect not to exist consumer groups on a specified endpoint.** -describe azure_iothub_event_hub_consumer_groups(resource_group: 'my-rg', resource_name: 'my-iot-hub', event_hub_endpoint: 'myeventhub') do +describe azure_iothub_event_hub_consumer_groups(resource_group: 'RESOURCE_GROUP', resource_name: 'IoT_NAME', event_hub_endpoint: 'EVENT_HUB_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault.md index 95972e1843..15942cedc1 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault.md @@ -10,25 +10,27 @@ identifier = "inspec/resources/azure/azure_key_vault Resource" parent = "inspec/resources/azure" +++ -Use the `azure_key_vault` InSpec audit resource to test properties related to a key vault. +Use the `azure_key_vault` InSpec audit resource to test the properties related to a key vault. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `name` or the `resource_id` must be given as a parameter. +`resource_group` and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_key_vault(resource_group: 'inspec-resource-group', name: 'vault-101') do +describe azure_key_vault(resource_group: 'RESOURCE_GROUP', name: 'VAULT-101') do it { should exist } its('name') { should cmp 'vault-101' } end ``` + ```ruby describe azure_key_vault(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.KeyVault/vaults/{vaultName}') do it { should exist } @@ -38,21 +40,22 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: Name of the Azure resource to test. `MyVault`. +: Name of the Azure resource to test. `vault_name` -: Name of the Azure resource to test (for backward compatibility). `MyVault`. +: Name of the Azure resource to test (for backward compatibility). `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.KeyVault/vaults/{vaultName}`. +: The unique resource ID. `diagnostic_settings_api_version` -: The endpoint api version for the `diagnostic_settings` property. `2017-05-01-preview` will be used for backward compatibility unless provided. +: The endpoint API version for the `diagnostic_settings` property. `2017-05-01-preview` will be used for backward compatibility unless provided. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` - `resource_group` and `vault_name` @@ -65,31 +68,33 @@ Either one of the parameter sets can be provided for a valid query: `diagnostic_settings_logs` : The logs enabled status of every category for the key vault. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/keyvault/vaults/get#vault) for other properties available. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/keyvault/keyvault/vaults/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test Key Vault's SKU Family.** +### Test key vault's SKU family ```ruby -describe azure_key_vault(resource_group: 'MyResourceGroup', name: 'MyVaultName') do +describe azure_key_vault(resource_group: 'RESOURCE_GROUP', name: 'VAULT_NAME') do its('properties.sku.family') { should eq 'A' } end ``` -**Test If Key Vault is Enabled for Disk Encryption.** + +### Test if the key vault is enabled for disk encryption ```ruby -describe azure_key_vault(resource_group: 'MyResourceGroup', name: 'MyVaultName') do +describe azure_key_vault(resource_group: 'RESOURCE_GROUP', name: 'VAULT_NAME') do its('properties.enabledForDiskEncryption') { should be_true } end ``` -**Test If Azure Key Vault audit logging is enabled.** + +### Test if Azure key vault audit logging is enabled ```ruby -describe azure_key_vault(resource_group: 'MyResourceGroup', name: 'MyVaultName') do +describe azure_key_vault(resource_group: 'RESOURCE_GROUP', name: 'VAULT_NAME') do its('diagnostic_settings_logs') { should include(true) } end ``` @@ -101,18 +106,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a key vault is found it will exist +# If a key vault is found, it will exist. -describe azure_key_vault(resource_group: 'MyResourceGroup', name: 'MyVaultName') do +describe azure_key_vault(resource_group: 'RESOURCE_GROUP', name: 'VAULT_NAME') do it { should exist } end +``` + +### not_exists + +```ruby +# Key vaults that aren't found, will not exist. -# Key vaults that aren't found will not exist -describe azure_key_vault(resource_group: 'MyResourceGroup', name: 'DoesNotExist') do +describe azure_key_vault(resource_group: 'RESOURCE_GROUP', name: 'VAULT_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_key.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_key.md index e84645e62c..7fdcd18813 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_key.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_key.md @@ -10,30 +10,32 @@ identifier = "inspec/resources/azure/azure_key_vault_key Resource" parent = "inspec/resources/azure" +++ -Use the `azure_key_vault_key` InSpec audit resource to test properties and configuration of an Azure key within a vault. +Use the `azure_key_vault_key` InSpec audit resource to test the properties and configuration of an Azure key within a vault. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_key_vault_key` resource block identifies an Azure key by `vault_name` and `key_name` or the `key_id`. -You may also specify a `key_version` - if no version is specified, the most recent version of the key will be used. +An `azure_key_vault_key` resource block identifies an Azure key by `vault_name` and `key_name`, or the `key_id`. You may also specify a `key_version`. If no version is specified, the most recent version of the key will be used. + ```ruby -describe azure_key_vault_key(vault_name: 'example_vault', key_name: 'example_key') do +describe azure_key_vault_key(vault_name: 'EXAMPLE_VAULT', key_name: 'EXAMPLE_KEY') do it { should exist } end ``` + ```ruby -describe azure_key_vault_key(vault_name: 'example_vault', key_name: 'example_key', key_version: '78deebed173b48e48f55abf87ed4cf71') do +describe azure_key_vault_key(vault_name: 'EXAMPLE_VAULT', key_name: 'EXAMPLE_KEY', key_version: '78deebed173b48e48f55abf87ed4cf71') do it { should exist } end ``` + ```ruby describe azure_key_vault_key(key_id: 'https://example_vault.vault.azure.net/keys/key/7df9bf2c3b4347bab213ebe233f0e350') do it { should exist } @@ -43,21 +45,22 @@ end ## Parameters `vault_name` -: The name of the key vault that the targeted key resides in. `my_vault`. +: The name of the key vault where the targeted key resides. `key_name` -: The name of the key to interrogate. `my_key`. +: The name of the key to interrogate. `name` -: Alias for the `key_name` parameter. `my_key`. +: Alias for the `key_name` parameter. `key_version` -: (Optional) - The version of a Key, e.g. `7df9bf2c3b4347bab213ebe233f0e350`. +: (Optional) - The version of a key. For example, `7df9bf2c3b4347bab213ebe233f0e350`. `key_id` -: The unique id of the key, e.g. `https://example_vault.vault.azure.net/keys/key/7df9bf2c3b4347bab213ebe233f0e350`. +: The unique ID of the key. For example, `https://example_vault.vault.azure.net/keys/key/7df9bf2c3b4347bab213ebe233f0e350`. Either one of the parameter sets can be provided for a valid query: + - `vault_name` and `key_name` - `vault_name` and `name` - `key_id` @@ -65,36 +68,43 @@ Either one of the parameter sets can be provided for a valid query: ## Properties `attributes` -: The key management attributes in [this](https://docs.microsoft.com/en-us/rest/api/keyvault/getkey/getkey#keyattributes) format. +: The key management attributes in [this](https://docs.microsoft.com/en-us/rest/api/keyvault/keys/get-key/get-key?tabs=HTTP#keyattributes) format. `key` -: The Json web key in [this](https://docs.microsoft.com/en-us/rest/api/keyvault/getkey/getkey#jsonwebkey) format. +: The JSON web key in [this](https://docs.microsoft.com/en-us/rest/api/keyvault/keys/get-key/get-key?tabs=HTTP#jsonwebkey) format. `managed` : `true` if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be `true`. `tags` -: Application specific metadata in the form of key-value pairs. +: Application-specific metadata in the form of key-value pairs. -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/keyvault/getkey/getkey#keybundle) for more details. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/keyvault/keys/get-key/get-key?tabs=HTTP) for more details. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test the Key Identifier.** +### Test the key identifier ```ruby -describe azure_key_vault_key(vault_name: 'example_vault', key_name: 'example_key', key_version: '7df9bf2c3b4347bab213ebe233f0e350') do +describe azure_key_vault_key(vault_name: 'EXAMPLE_VAULT', key_name: 'EXAMPLE_KEY', key_version: '7df9bf2c3b4347bab213ebe233f0e350') do its('key.kid') { should cmp 'https://example_vault.vault.azure.net/keys/key/7df9bf2c3b4347bab213ebe233f0e350' } end ``` -**Test if the Key is Enabled.** + +### Test if the key is enabled ```ruby -describe azure_key_vault_key(vault_name: 'example_vault', key_name: 'example_key') do +describe azure_key_vault_key(vault_name: 'EXAMPLE_VAULT', key_name: 'EXAMPLE_KEY') do its('attributes.enabled') { should eq true } end ``` +### Test if the rotationploicy is enabled + +```ruby +describe azure_key_vault_key(vault_name: 'EXAMPLE_VAULT', key_name: 'EXAMPLE_KEY') do + it { should have_rotation_policy_enabled } +end +``` ## Matchers @@ -103,19 +113,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect the key to always exist +# If we expect the key to always exist. -describe azure_key_vault_key(vault_name: 'example_vault', key_name: 'example_key') do +describe azure_key_vault_key(vault_name: 'EXAMPLE_VAULT', key_name: 'EXAMPLE_KEY') do it { should exist } end +``` + +### not_exists -# If we expect the key to never exist +```ruby +# If we expect the key to never exist. -describe azure_key_vault_key(vault_name: 'example_vault', key_name: 'example_key') do +describe azure_key_vault_key(vault_name: 'EXAMPLE_VAULT', key_name: 'EXAMPLE_KEY') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_keys.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_keys.md index c40728fa15..b48d0c8de6 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_keys.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_keys.md @@ -10,22 +10,22 @@ identifier = "inspec/resources/azure/azure_key_vault_keys Resource" parent = "inspec/resources/azure" +++ -Use the `azure_key_vault_keys` InSpec audit resource to test properties and configuration of multiple of Azure keys within vaults. +Use the `azure_key_vault_keys` InSpec audit resource to test the properties and configuration of multiple Azure keys within vaults. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax An `azure_key_vault_keys` resource block returns all keys within a vault. ```ruby -describe azure_key_vault_keys(vault_name: 'example_vault') do +describe azure_key_vault_keys(vault_name: 'EXAMPLE_VAULT') do #... end ``` @@ -39,12 +39,12 @@ end ## Properties `attributes` -: A list of the key management attributes in [this](https://docs.microsoft.com/en-us/rest/api/keyvault/getkey/getkey#keyattributes) format. +: A list of the key management attributes in [this](https://docs.microsoft.com/en-us/rest/api/keyvault/keys/get-key/get-key?tabs=HTTP#keyattributes) format. : **Field**: `attributes` `kids` -: A list of key ids. +: A list of key IDs. : **Field**: `kid` @@ -58,22 +58,27 @@ end : **Field**: `tags` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test that a Vault has the Named Key.** +### Test that a vault has the named key ```ruby -describe azure_key_vault_keys(vault_name: 'example_vault').where { kid.include?('my_key')} do +describe azure_key_vault_keys(vault_name: 'EXAMPLE_VAULT').where { kid.include?('KEY_NAME')} do it { should exist } its('count') { should be 1 } end ``` -**Loop through Keys by the Key ID.** + +### Loop through keys by the key ID ```ruby -azure_key_vault_keys(vault_name: 'example_vault').kids.each do |kid| +azure_key_vault_keys(vault_name: 'EXAMPLE_VAULT').kids.each do |kid| describe azure_key_vault_key(key_id: kid) do it { should exist } end @@ -82,25 +87,32 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby -# If we expect to have at least one key in a vault +# If we expect to have at least one key in a vault. -describe azure_key_vault_keys(vault_name: 'example_vault') do +describe azure_key_vault_keys(vault_name: 'EXAMPLE_VAULT') do it { should exist } end +``` -# If we expect not have any keys in a vault +### not_exists + +```ruby +# If we expect not to have any keys in a vault. -describe azure_key_vault_keys(vault_name: 'example_vault') do +describe azure_key_vault_keys(vault_name: 'EXAMPLE_VAULT') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_secret.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_secret.md index 3bc2680a8f..d9d9d80ef6 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_secret.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_secret.md @@ -10,30 +10,32 @@ identifier = "inspec/resources/azure/azure_key_vault_secret Resource" parent = "inspec/resources/azure" +++ -Use the `azure_key_vault_secret` InSpec audit resource to test properties and configuration of an Azure secret within a vault. +Use the `azure_key_vault_secret` InSpec audit resource to test the properties and configuration of an Azure secret within a vault. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_key_vault_secret` resource block identifies an Azure secret by `vault_name` and `secret_name` or the `secret_id`. -You may also specify a `secret_version` - if no version is specified, the most recent version of the secret will be used. +An `azure_key_vault_secret` resource block identifies an Azure secret by `vault_name` and `secret_name`, or the `secret_id`. You may also specify a `secret_version`. If no version is specified, the most recent version of the secret is used. + ```ruby -describe azure_key_vault_secret(vault_name: 'example_vault', secret_name: 'example_secret') do +describe azure_key_vault_secret(vault_name: 'EXAMPLE_VAULT', secret_name: 'EXAMPLE_SECRET') do it { should exist } end ``` + ```ruby -describe azure_key_vault_secret(vault_name: 'example_vault', secret_name: 'example_secret', secret_version: '78deebed173b48e48f55abf87ed4cf71') do +describe azure_key_vault_secret(vault_name: 'EXAMPLE_VAULT', secret_name: 'EXAMPLE_SECRET', secret_version: '78deebed173b48e48f55abf87ed4cf71') do it { should exist } end ``` + ```ruby describe azure_key_vault_secret(secret_id: 'https://example_vault.vault.azure.net/secrets/secret_name/7df9bf2c3b4347bab213ebe233f0e350') do it { should exist } @@ -43,21 +45,22 @@ end ## Parameters `vault_name` -: The name of the key vault that the targeted secret resides in. `my_vault`. +: The key vault name where the targeted secret resides. `secret_name` -: The name of the secret to interrogate. `my_secret`. +: The name of the secret to interrogate. `name` -: Alias for the `secret_name` parameter. `my_secret`. +: Alias for the `secret_name` parameter. -`secret_version` -: (Optional) - The version of a secret, e.g. `7df9bf2c3b4347bab213ebe233f0e350`. +`secret_version` _Optional_ +: The version of a secret. For example, `7df9bf2c3b4347bab213ebe233f0e350`. `secret_id` -: The unique id of the secret, e.g. `https://example_vault.vault.azure.net/secrets/secret_name/7df9bf2c3b4347bab213ebe233f0e350`. +: The unique ID of the secret. For example, `https://example_vault.vault.azure.net/secrets/secret_name/7df9bf2c3b4347bab213ebe233f0e350`. Either one of the parameter sets can be provided for a valid query: + - `vault_name` and `secret_name` - `vault_name` and `name` - `secret_id` @@ -65,13 +68,13 @@ Either one of the parameter sets can be provided for a valid query: ## Properties `id` -: The secret id. `https://example_vault.vault.azure.net/secrets/secret_name`. +: The secret ID. `https://example_vault.vault.azure.net/secrets/secret_name`. `kid` : If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate. `attributes` -: The secret management attributes in [this](https://docs.microsoft.com/en-us/rest/api/keyvault/getsecret/getsecret#secretattributes) format. +: The secret management attributes in [this](https://docs.microsoft.com/en-us/rest/api/keyvault/secrets/get-secrets/get-secrets?tabs=HTTP#secretattributes) format. `contentType` : The content type of the secret. @@ -88,22 +91,23 @@ Either one of the parameter sets can be provided for a valid query: `value` : The secret's value. -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/keyvault/getsecret/getsecret#secretbundle) for more details. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/keyvault/secrets/get-secrets/get-secrets) for more details. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test the Secret Identifier.** +### Test the secret identifier ```ruby -describe azure_key_vault_secret(vault_name: 'example_vault', secret_name: 'example_secret') do +describe azure_key_vault_secret(vault_name: 'EXAMPLE_VAULT', secret_name: 'EXAMPLE_SECRET') do its('id') { should cmp 'https://example_vault.vault.azure.net/secrets/example_secret' } end ``` -**Test if the Secret is Enabled.** + +### Test if the secret is enabled ```ruby -describe azure_key_vault_secret(vault_name: 'example_vault', secret_name: 'example_secret') do +describe azure_key_vault_secret(vault_name: 'EXAMPLE_VAULT', secret_name: 'EXAMPLE_SECRET') do its('attributes.enabled') { should eq true } end ``` @@ -115,19 +119,21 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect the secret to always exist - -describe azure_key_vault_secret(vault_name: 'example_vault', secret_name: 'example_secret') do +# If we expect the secret to always exist. +describe azure_key_vault_secret(vault_name: 'EXAMPLE_VAULT', secret_name: 'EXAMPLE_SECRET') do it { should exist } end +``` -# If we expect the secret to never exist +### not_exists -describe azure_key_vault_secret(vault_name: 'example_vault', secret_name: 'example_secret') do +```ruby +# If we expect the secret to never exist. +describe azure_key_vault_secret(vault_name: 'EXAMPLE_VAULT', secret_name: 'EXAMPLE_SECRET') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_secrets.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_secrets.md index b95b99100c..142a157c16 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_secrets.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vault_secrets.md @@ -10,22 +10,22 @@ identifier = "inspec/resources/azure/azure_key_vault_secrets Resource" parent = "inspec/resources/azure" +++ -Use the `azure_key_vault_secrets` InSpec audit resource to test properties and configuration of multiple of Azure secrets within vaults. +Use the `azure_key_vault_secrets` InSpec audit resource to test the properties and configuration of multiple Azure secrets within vaults. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax An `azure_key_vault_secrets` resource block returns all secrets within a vault. ```ruby -describe azure_key_vault_secrets(vault_name: 'example_vault') do +describe azure_key_vault_secrets(vault_name: 'EXAMPLE_VAULT') do #... end ``` @@ -39,12 +39,12 @@ end ## Properties `attributes` -: A list of the secret management attributes in [this](https://docs.microsoft.com/en-us/rest/api/keyvault/getsecret/getsecret#secretattributes) format. +: A list of the secret management attributes in [this](https://docs.microsoft.com/en-us/rest/api/keyvault/secrets/get-secrets/get-secrets?tabs=HTTP#secretattributes) format. : **Field**: `attributes` `ids` -: A list of secret ids. +: A list of secret IDs. : **Field**: `id` @@ -54,7 +54,7 @@ end : **Field**: `managed` `contentTypes` -: A list of content type of the secrets being interrogated. +: A list of secrets content type being interrogated. : **Field**: `contentType` @@ -63,22 +63,27 @@ end : **Field**: `tags` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test that a Vault has the Named Secret.** +### Test that a vault has the named secret ```ruby -describe azure_key_vault_secrets(vault_name: 'example_vault').where { id.include?('my_secret')} do +describe azure_key_vault_secrets(vault_name: 'EXAMPLE_VAULT').where { id.include?('SECRET')} do it { should exist } its('count') { should be 1 } end ``` -**Loop through Secrets by their IDs.** + +### Loop through secrets by their IDs ```ruby -azure_key_vault_secrets(vault_name: 'example_vault').ids.each do |id| +azure_key_vault_secrets(vault_name: 'EXAMPLE_VAULT').ids.each do |id| describe azure_key_vault_secret(secret_id: id) do it { should exist } end @@ -87,25 +92,30 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. -```ruby -# If we expect to have at least one secret in a vault +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. -describe azure_key_vault_secrets(vault_name: 'example_vault') do +```ruby +# If we expect to have at least one secret in a vault. +describe azure_key_vault_secrets(vault_name: 'EXAMPLE_VAULT') do it { should exist } end +``` -# If we expect not have any secrets in a vault +### not_exists -describe azure_key_vault_secrets(vault_name: 'example_vault') do +```ruby +# If we expect not have any secrets in a vault. +describe azure_key_vault_secrets(vault_name: 'EXAMPLE_VAULT') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vaults.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vaults.md index 9199b41b76..3843edc8b5 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vaults.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_key_vaults.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_key_vaults Resource" parent = "inspec/resources/azure" +++ -Use the `azure_key_vaults` InSpec audit resource to test properties related to key vaults for a resource group or the entire subscription. +Use the `azure_key_vaults` InSpec audit resource to test the properties related to key vaults for a resource group or the entire subscription. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_key_vaults` resource block returns all Azure key vaults, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_key_vaults` resource block returns all Azure key vaults, either within a resource group (if provided) or the entire subscription. + ```ruby describe azure_key_vaults do #... end ``` -or + +Or + ```ruby -describe azure_key_vaults(resource_group: 'my-rg') do +describe azure_key_vaults(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -73,27 +76,33 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through Key Vaults by Their Ids .** +### Loop through key vaults by their IDs ```ruby azure_key_vaults.ids.each do |id| describe azure_key_vault(resource_id: id) do it { should exist } end -end -``` -**Test that There are Key Vaults that Includes a Certain String in their Names (Client Side Filtering) .** +end +``` + +### Test to ensure there are key vaults that include a certain string in their names (Client Side Filtering) ```ruby describe azure_key_vaults.where { name.include?('deployment') } do it { should exist } end -``` -**Test that There are Key Vaults that Includes a Certain String in their Names (Server Side Filtering via Generic Resource - Recommended) .** +``` + +### Test to ensure there are key vaults that include a certain string in their names (Server Side Filtering via Generic Resource - Recommended) ```ruby describe azure_generic_resources(resource_provider: 'Microsoft.KeyVault/vaults', substring_of_name: 'deployment') do @@ -103,24 +112,30 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -### exists +This resource has the following special matchers. + +### not_exists ```ruby -# Should not exist if no key vaults are in the resource group +# Should not exist if no key vaults are in the resource group. -describe azure_key_vaults(resource_group: 'MyResourceGroup') do +describe azure_key_vaults(resource_group: 'RESOURCE_GROUP') do it { should_not exist } end +``` + +### exists -# Should exist if the filter returns at least one key vault +```ruby +# Should exist if the filter returns at least one key vault. -describe azure_key_vaults(resource_group: 'MyResourceGroup') do +describe azure_key_vaults(resource_group: 'RESOURCE_GROUP') do it { should exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_load_balancer.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_load_balancer.md index 11097f7800..f5aac7caa3 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_load_balancer.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_load_balancer.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_load_balancer Resource" parent = "inspec/resources/azure" +++ -Use the `azure_load_balancer` InSpec audit resource to test properties and configuration of an Azure Load Balancer. +Use the `azure_load_balancer` InSpec audit resource to test the properties and configuration of an Azure Load Balancer. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `name` or the `resource_id` must be given as a parameter. +`resource_group` and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_load_balancer(resource_group: 'inspec-resource-group-9', name: 'example_lb') do +describe azure_load_balancer(resource_group: 'RESOURCE_GROUP', name: 'EXAMPLE_LB') do it { should exist } end ``` + ```ruby describe azure_load_balancer(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}') do it { should exist } @@ -37,51 +39,50 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: The unique name of the load balancer. `loadBalancerName`. +: The unique name of the load balancer. `loadbalancer_name` : Alias for the `name` parameter. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` - `resource_group` and `loadbalancer_name` - ## Properties `sku.name` : Name of a load balancer SKU. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/load-balancer/loadbalancers/get#loadbalancer) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/load-balancer/loadbalancers/get#loadbalancer) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test if a Load Balancer has Any Inbound Nat Rules.** +### Test if a Load Balancer has any inbound nat rules ```ruby -describe azure_load_balancer(resource_group: 'my-rg', name: 'lb-1') do +describe azure_load_balancer(resource_group: 'RESOURCE_GROUP', name: 'EXAMPLE_LB') do its('properties.inboundNatRules') { should_not be_empty } end ``` -**Loop through All Load Balancers in a Subscription via `resource_id`.** +### Loop through all Load Balancers in a subscription via 'resource_id' ```ruby azure_load_balancers.ids.each do |id| describe azure_load_balancer(resource_id: id) do its('properties.inboundNatRules') { should_not be_empty } end -end +end ``` ## Matchers @@ -91,19 +92,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect the resource to always exist +# If we expect the resource to always exist. -describe azure_load_balancer(resource_group: 'my-rg', name: 'lb-1') do +describe azure_load_balancer(resource_group: 'RESOURCE_GROUP', name: 'EXAMPLE_LB') do it { should exist } end +``` -# If we expect the resource to never exist +### not_exists + +```ruby +# If we expect the resource to never exist. -describe azure_load_balancer(resource_group: 'my-rg', name: 'lb-1') do +describe azure_load_balancer(resource_group: 'RESOURCE_GROUP', name: 'EXAMPLE_LB') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_load_balancers.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_load_balancers.md index 060386e92d..5c85775f33 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_load_balancers.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_load_balancers.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_load_balancers Resource" parent = "inspec/resources/azure" +++ -Use the `azure_load_balancers` InSpec audit resource to test properties and configuration of Azure Load Balancers. +Use the `azure_load_balancers` InSpec audit resource to test the properties and configuration of Azure Load Balancers. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_load_balancers` resource block returns all Azure Load Balancers, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_load_balancers` resource block returns all Azure Load Balancers, either within a resource group (if provided) or the entire subscription. + ```ruby describe azure_load_balancers do #... end ``` -or + +Or + ```ruby -describe azure_load_balancers(resource_group: 'my-rg') do +describe azure_load_balancers(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -78,52 +81,67 @@ end : **Field**: `sku` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check Load balancers are Present.** +### Check Load balancers are present ````ruby describe azure_load_balancers do it { should exist } - its('names') { should include 'my-lb' } + its('names') { should include 'EXAMPLE_LB' } end ```` -**Filter the Results to Include Only those with Names Match the Given String Value.** + +### Filter the results to include only those with names match the specified string value ```ruby -describe azure_load_balancers.where{ name.eql?('production-lb') } do +describe azure_load_balancers.where{ name.eql?('PRODUCTION-LB') } do it { should exist } end ``` -**Filter the Results to Include Only those with Location Match the Given String Value.** + +### Filter the results to include only those with location match the specified string value ```ruby -describe azure_load_balancers.where{ location.eql?('eastus-2') } do +describe azure_load_balancers.where{ location.eql?('EASTUS-2') } do it { should exist } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. + ```ruby -# If we expect 'ExampleGroup' Resource Group to have Load Balancers -describe azure_load_balancers(resource_group: 'ExampleGroup') do +# If we expect 'EXAMPLEGROUP' resource group to have Load Balancers. +describe azure_load_balancers(resource_group: 'EXAMPLEGROUP') do it { should exist } end +``` -# If we expect 'EmptyExampleGroup' Resource Group to not have Load Balancers -describe azure_load_balancers(resource_group: 'ExampleGroup') do +### not_exists + +Use `should_not` if you expect zero matches. + +```ruby +# If we expect 'EMPTYEXAMPLEGROUP' resource group to not have Load Balancers. +describe azure_load_balancers(resource_group: 'EMPTYEXAMPLEGROUP') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_lock.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_lock.md index 6e3cfca897..e187aadf08 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_lock.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_lock.md @@ -10,21 +10,22 @@ identifier = "inspec/resources/azure/azure_lock Resource" parent = "inspec/resources/azure" +++ -Use the `azure_lock` InSpec audit resource to test properties and configuration of a management lock. +Use the `azure_lock` InSpec audit resource to test the properties and configuration of a Management Lock. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -The management lock resources do not follow the common `resouce_group` and `name` pattern for identification. -As a result of that, the `resource_id` must be given as a parameter to the `azure_lock` resource. -The [`azure_locks`]({{< relref "azure_locks.md" >}}) resource can be used for gathering the management lock resource ids to be tested within the desired level, such as, subscription, resource group or individual resource. +The Management Lock resources do not follow the common `resouce_group` and `name` patterns for identification. As a result, the `resource_id` must be given as a parameter to the `azure_lock` resource. + +The [`azure_locks`]({{< relref "azure_locks.md" >}}) resource can be used for gathering the Management Lock resource IDs to be tested within the desired level, such as subscription, resource group, or individual resource. + ```ruby describe azure_lock(resource_id: '/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks/{lockName}') do it { should exist } @@ -34,12 +35,12 @@ end ## Parameters `resource_id` -: The unique resource ID. `/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks/{lockName}`. +: The unique resource ID. ## Properties `properties.level` -: The level of the lock. Possible values are: `NotSpecified`, `CanNotDelete`, `ReadOnly`. For more see [here](https://docs.microsoft.com/en-us/rest/api/resources/managementlocks/getatresourcelevel#locklevel). +: The level of the lock. Possible values are: `NotSpecified`, `CanNotDelete`, and `ReadOnly`. For more see [here](https://docs.microsoft.com/en-us/rest/api/resources/managementlocks/getatresourcelevel#locklevel). `properties.notes` : Notes about the lock. Maximum of 512 characters. @@ -49,23 +50,23 @@ end Please note that the properties can vary depending on the `api_version` used for the lookup. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/resources/managementlocks/getatresourcelevel#managementlockobject) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/resources/managementlocks/getatresourcelevel#managementlockobject) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test If a `ReadOnly` Management Lock Exist in a Specific Resource Group.** +### Test if a 'ReadOnly' Management Lock exists in a specific resource group ```ruby -azure_locks(resource_group: 'example-group').ids.each do |id| +azure_locks(resource_group: 'EXAMPLE-GROUP').ids.each do |id| describe azure_lock(resource_id: id) do its('properties.level') { should_not cmp `ReadOnly` } end end ``` -**Test If Management Locks on a Specific Resource Contain a Certain String.** + +### Test if Management Locks on a specific resource contain a certain String ```ruby azure_locks(resouce_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}').ids.each do |lock_id| @@ -73,21 +74,28 @@ azure_locks(resouce_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourc it('properties.notes') { should include 'contact jdoe@chef.io' } end end -``` +``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# If we expect a resource to always exist +# If we expect a resource to always exist. describe azure_lock(resource_id: '/subscriptions/..{lockName}') do it { should exist } end -# If we expect a resource to never exist +``` + +### not_exists + +```ruby +# If we expect a resource to never exist. describe azure_lock(resource_id: '/subscriptions/..{lockName}') do it { should_not exist } @@ -96,4 +104,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_locks.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_locks.md index 7686602557..4b17e6a10b 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_locks.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_locks.md @@ -10,37 +10,44 @@ identifier = "inspec/resources/azure/azure_locks Resource" parent = "inspec/resources/azure" +++ -Use the `azure_locks` InSpec audit resource to test properties and configuration of all management locks for an Azure resource or any level below it. +Use the `azure_locks` InSpec audit resource to test the properties and configuration of all Management Locks for an Azure resource or any level below it. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_locks` resource block returns all management locks, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_locks` resource block returns all Management Locks within a resource group (if provided) or the entire subscription. + ```ruby describe azure_locks do it { should exist } end ``` -or + +Or + ```ruby -describe azure_locks(resource_group: 'my-rg') do +describe azure_locks(resource_group: 'RESOURCE_GROUP') do it { should exist } end ``` -Also, at resource level test can be done providing the following identifiers: `resource_group`, `resource_name` and `resource_type` or the `resource_id`. + +Also, at resource level test can be done by providing the following identifiers: `resource_group`, `resource_name`, and `resource_type` or the `resource_id`. + ```ruby -describe azure_locks(resource_group: 'rg-1', resource_name: 'my-VM', resource_type: 'Microsoft.Compute/virtualMachines') do +describe azure_locks(resource_group: 'RESOURCE_GROUP', resource_name: 'VM_NAME`, resource_type: 'Microsoft.Compute/virtualMachines') do it { should exist } end ``` -or + +Or + ```ruby describe azure_locks(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}') do it { should exist } @@ -50,18 +57,19 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `resource_name` -: Name of the Azure resource on which the management locks are being tested. `MyVM`. +: Name of the Azure resource on which the Management Locks are being tested. `resource_type` -: Type of the Azure resource on which the management locks are being tested. `Microsoft.Compute/virtualMachines`. +: Type of the Azure resource on which the Management Locks are being tested. `resource_id` -: The unique resource ID of the Azure resource on which the management locks are being tested. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}`. +: The unique resource ID of the Azure resource on which the Management Locks are being tested. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group`, `resource_name` and `resource_type` - `resource_group` @@ -70,39 +78,45 @@ Either one of the parameter sets can be provided for a valid query: ## Properties `ids` -: A list of the unique resource ids of the management locks. +: A list of the unique resource IDs of the Management Locks. : **Field**: `id` `names` -: A list of names of all the management locks being interrogated. +: A list of names of all the Management Locks being interrogated. : **Field**: `name` `properties` -: A list of properties for all the management locks being interrogated. +: A list of properties for all the Management Locks being interrogated. : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check If a Specific Management Lock is Present for a Resource.** +### Check if a specific Management Lock is present for a resource ```ruby -describe azure_locks(resource_group: 'rg-1', resource_name: 'my-VM', resource_type: 'Microsoft.Compute/virtualMachines') do +describe azure_locks(resource_group: 'RESOURCE_GROUP', resource_name: 'VM_NAME', resource_type: 'Microsoft.Compute/virtualMachines') do its('names') { should include 'production_agents' } end ``` -**Filters the Results to Include Only Those Management Locks which Include the Given Name.** + +### Filters the results to include only those Management Locks that have the specific name ```ruby describe azure_locks.where{ name.include?('production') } do it { should exist } end ``` -**Loop through All Virtual Machines to Test If They have Management Locks Defined on.** + +### Loop through all virtual machines to test if they have Management Locks defined ```ruby azure_virtual_machines.ids.each do |id| @@ -114,17 +128,19 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. ```ruby -describe azure_locks(resource_group: 'rg-1', resource_name: 'my-VM', resource_type: 'Microsoft.Compute/virtualMachines') do +describe azure_locks(resource_group: 'RESOURCE_GROUP', resource_name: 'VM_NAME', resource_type: 'Microsoft.Compute/virtualMachines') do it { should exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_managed_application.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_managed_application.md new file mode 100644 index 0000000000..950990a86c --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_managed_application.md @@ -0,0 +1,117 @@ ++++ +title = "azure_managed_application Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_managed_application" +identifier = "inspec/resources/azure/azure_managed_application Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_managed_application` InSpec audit resource to test the properties related to an Azure Managed application. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +`name` and `resource_group` are required parameters. + +```ruby +describe azure_managed_application(resource_group: 'RESOURCE_GROUP', name: 'MANAGED_APPLICATION_NAME') do + it { should exist } + its('type') { should eq 'Microsoft.ServiceBus/Namespaces' } + its('location') { should eq 'East US' } +end +``` + +```ruby +describe azure_managed_application(resource_group: 'RESOURCE_GROUP', name: 'MANAGED_APPLICATION_NAME') do + it { should exist } +end +``` + +## Parameters + +`name` _(required)_ +: Name of the Azure managed applications to test. + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`id` +: Resource ID. + +`name` +: Resource name. + +`type` +: Resource type. `Microsoft.Solutions/applications`. + +`location` +: Resource location. + +`properties` +: The properties of the managed application. + +`properties.plan` +: The plan information. + +`properties.identity` +: The identity of the resource. + +`properties.provisioningState` +: Provisioning state of the namespace. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/managedapplications/applications/get) for other properties available. + +## Examples + +### Test that the managed applications are provisioned successfully + +```ruby +describe azure_managed_application(resource_group: 'RESOURCE_GROUP', name: 'MANAGED_APPLICATION_NAME') do + its('properties.provisioningState') { should eq 'Succeeded' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If a Managed application is found, it will exist. + +describe azure_managed_application(resource_group: 'RESOURCE_GROUP', name: 'MANAGED_APPLICATION_NAME') do + it { should exist } +end +``` + +### not_exists + +```ruby +# If a Managed application is not found, it will not exist. + +describe azure_managed_application(resource_group: 'RESOURCE_GROUP', name: 'MANAGED_APPLICATION_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_managed_applications.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_managed_applications.md new file mode 100644 index 0000000000..5b7a7aca82 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_managed_applications.md @@ -0,0 +1,139 @@ ++++ +title = "azure_managed_applications Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_managed_applications" +identifier = "inspec/resources/azure/azure_managed_applications Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_managed_applications` InSpec audit resource to test the properties related to all Azure Managed applications. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_managed_applications` resource block returns all Azure Managed applications. + +```ruby +describe azure_managed_applications do + #... +end +``` + +## Parameters + +`resource_group` _(optional)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`ids` +: A list of resource IDs. + +: **Field**: `id` + +`names` +: A list of resource Names. + +: **Field**: `name` + +`types` +: A list of the resource types. + +: **Field**: `type` + +`properties` +: A list of properties for all the Managed applications. + +: **Field**: `properties` + +`locations` +: A list of the resource locations. + +: **Field**: `location` + +`identities` +: A list of the identity of the resources. + +: **Field**: `identity` + +`plans` +: A list of the plan information. + +: **Field**: `plan` + +`provisioningStates` +: A list of provisioning states of the app. + +: **Field**: `provisioningState` + +`publisherTenantIds` +: A list of the publisher tenant ID. + +: **Field**: `publisherTenantId` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Loop through Managed applications by their names + +```ruby +azure_managed_applications(resource_group: 'RESOURCE_GROUP').names.each do |name| + describe azure_managed_application(resource_group: 'RESOURCE_GROUP', name: name) do + it { should exist } + end +end +``` + +### Test that there are Managed applications that are successfully provisioned + +```ruby +describe azure_managed_applications(resource_group: 'RESOURCE_GROUP').where(provisioningState: 'Succeeded') do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no Managed applications are present. + +describe azure_managed_applications(resource_group: 'RESOURCE_GROUP') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Managed application. + +describe azure_managed_applications(resource_group: 'RESOURCE_GROUP') do + it { should exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_management_group.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_management_group.md index bf173769a1..898290cd66 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_management_group.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_management_group.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_management_group Resource" parent = "inspec/resources/azure" +++ -Use the `azure_management_group` InSpec audit resource to test properties of an Azure management group. +Use the `azure_management_group` InSpec audit resource to test the properties of an Azure management group. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax An `azure_management_group` resource block identifies a management group by its `name` or the `resource_id`. + ```ruby -describe azure_management_group(name: 'abcd-1234') do +describe azure_management_group(name: 'ABCD-1234') do it { should exist } end ``` + ```ruby describe azure_management_group(resource_id: '/providers/Microsoft.Management/managementGroups/{groupId}') do it { should exist } @@ -46,35 +48,36 @@ end : The unique resource ID. `/providers/Microsoft.Management/managementGroups/{groupId}`. `expand` -: Optional. The `expand: 'children'` includes children in the response. `expand: 'path'` includes the path from the root group to the current group. +: Optional. The `expand: 'children'` includes children in the response. The `expand: 'path'` includes the path from the root group to the current group. `recurse` : Optional. The `recurse: true` includes the entire hierarchy in the response. Note that `expand: 'children'` will be set if `recurse` is set to `true`. -`filter` -: Optional. A filter which allows the exclusion of subscriptions from results (i.e. `filter: 'children.childType ne Subscription'`). +`filter` _Optional_ +: A filter allows the exclusion of subscriptions from results (i.e., `filter: 'children.childType ne Subscription'`). Either one of the parameter sets can be provided for a valid query along with the optional parameters: + - `resource_id` - `name` -- `group_id` +- `group_id` ## Properties `tenant_id` -: The management group tenant id. +: The management group tenant ID. `parent_name` : The management group parent name. `parent_id` -: The management group parent resource id. `/providers/Microsoft.Management/managementGroups/{groupId}`. +: The management group parent resource ID. `/providers/Microsoft.Management/managementGroups/{groupId}`. `children_display_names` : The list of management group children display names. `children_ids` -: The list of management group children ids. +: The list of management group children IDs. `children_names` : The list of management group children names. @@ -82,23 +85,23 @@ Either one of the parameter sets can be provided for a valid query along with th `children_types` : The list of management group children types. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/resources/managementgroups/get#managementgroup) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/managementgroups/management-groups/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test Tenant ID, Parent Name, Children Display Name.** +### Test Tenant ID, Parent Name, Children Display Name ```ruby -describe azure_management_group(group_id: 'abc-1234', recurse: true, expand: 'children') do +describe azure_management_group(group_id: 'ABC-1234', recurse: true, expand: 'CHILDREN') do its('tenant_id') { should eq('00000000-0000-0000-0000-000000000000') } its('parent_name') { should eq('MyGroupsParentName') } its('children_display_names') { should include('I am a child of the group!') } end ``` -See [integration tests](../../test/integration/verify/controls/azurerm_management_group.rb) for more examples. + +See [integration tests](https://github.com/inspec/inspec-azure/blob/main/test/integration/verify/controls/azure_management_group.rb) for more examples. ## Matchers @@ -107,19 +110,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect a resource to always exist +# If we expect a resource to always exist. -describe azure_management_group(name: 'abcd-1234') do +describe azure_management_group(name: 'ABCD-1234') do it { should exist } end +``` + +### not_exists -# If we expect a resource to never exist +```ruby +# If we expect a resource to never exist. -describe azure_management_group(name: 'abcd-1234') do +describe azure_management_group(name: 'ABCD-1234') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_management_groups.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_management_groups.md index b283973483..9badb91035 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_management_groups.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_management_groups.md @@ -10,19 +10,20 @@ identifier = "inspec/resources/azure/azure_management_groups Resource" parent = "inspec/resources/azure" +++ -Use the `azure_management_groups` InSpec audit resource to test properties and configuration of multiple Azure management groups. +Use the `azure_management_groups` InSpec audit resource to test the properties and configuration of multiple Azure management groups. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax An `azure_management_groups` resource block returns management groups for the authenticated user. + ```ruby describe azure_management_groups do #... @@ -36,7 +37,7 @@ This resource does not require any parameters. ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -55,33 +56,44 @@ This resource does not require any parameters. : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test that a Named Management Group Exist.** +### Test that a named Management Group exists ```ruby describe azure_management_groups do - its('names') { should include('abcd-1234') } + its('names') { should include('ABCD-1234') } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby -# If we expect at least one management group to exist +# If we expect at least one management group to exist. describe azure_management_groups do it { should exist } end +``` -# If we expect zero matches +### not_exists + +```ruby +# If we expect zero matches. describe azure_management_groups do it { should_not exist } @@ -90,4 +102,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mariadb_server.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mariadb_server.md index 288fe4b13e..d8ffac8c15 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mariadb_server.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mariadb_server.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_mariadb_server Resource" parent = "inspec/resources/azure" +++ -Use the `azure_mariadb_server` InSpec audit resource to test properties and configuration of an Azure MariaDB Server. +Use the `azure_mariadb_server` InSpec audit resource to test the properties and configuration of an Azure MariaDB Server. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `name` or the `resource_id` must be given as a parameter. +`resource_group` and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_mariadb_server(resource_group: 'inspec-resource-group-9', name: 'example_server') do +describe azure_mariadb_server(resource_group: 'RESOURCE_GROUP', name: 'EXAMPLE_SERVER') do it { should exist } end ``` + ```ruby describe azure_mariadb_server(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.DBforMariaDB/servers/{serverName}') do it { should exist } @@ -37,21 +39,22 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: Name of the MariaDB server to test. `MyServer`. +: Name of the MariaDB server to test. `server_name` : Alias for the `name` parameter. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.DBforMariaDB/servers/{serverName}`. +: The unique resource ID. `firewall_rules_api_version` : The endpoint api version for the `firewall_rules` property. The latest version will be used unless provided. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` - `resource_group` and `server_name` @@ -64,35 +67,38 @@ Either one of the parameter sets can be provided for a valid query: `sku` : The SKU (pricing tier) of the server. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/mariadb/servers/get#server) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/mariadb/servers/get#server) for other properties available. +Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test If a MariaDB Server is Referenced with a Valid Name.** +### Test if a MariaDB server is referenced with a valid name ```ruby -describe azure_mariadb_server(resource_group: 'my-rg', name: 'sql-server-1') do +describe azure_mariadb_server(resource_group: 'RESOURCE_GROUP', name: 'SQL-SERVER-1') do it { should exist } end ``` -**Test If a MariaDB Server is Referenced with an Invalid Name.** + +### Test if a MariaDB server is referenced with an invalid name ```ruby -describe azure_mariadb_server(resource_group: 'my-rg', name: 'i-dont-exist') do +describe azure_mariadb_server(resource_group: 'RESOURCE_GROUP', name: 'I-DONT-EXIST') do it { should_not exist } end -``` -**Test If a MariaDB Server Has Firewall Rules Set.** +``` + +### Test if a MariaDB server has firewall rules set ```ruby -describe azure_mariadb_server(resource_group: 'my-rg', name: 'my-server') do +describe azure_mariadb_server(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('firewall_rules') { should_not be_empty } end -``` -**Test a MariaDB Server's Location and Maximum Replica Capacity.** +``` + +### Test a MariaDB server's location and maximum replica capacity ```ruby describe azure_mariadb_server(resource_id: '/subscriptions/.../my-server') do @@ -108,18 +114,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect a resource to always exist +# If we expect a resource to always exist. -describe azure_mariadb_server(resource_group: 'my-rg', server_name: 'server-name-1') do +describe azure_mariadb_server(resource_group: 'RESOURCE_GROUP, server_name: 'SQL-SERVER-1') do it { should exist } end -# If we expect a resource to never exist +``` + +### not_exists + +```ruby +# If we expect a resource to never exist. -describe azure_mariadb_server(resource_group: 'my-rg', server_name: 'server-name-1') do +describe azure_mariadb_server(resource_group: 'RESOURCE_GROUP', server_name: 'SQL-SERVER-1') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mariadb_servers.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mariadb_servers.md index c44959b3c8..769929096a 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mariadb_servers.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mariadb_servers.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_mariadb_servers Resource" parent = "inspec/resources/azure" +++ -Use the `azure_mariadb_servers` InSpec audit resource to test properties and configuration of multiple Azure MariaDB Servers. +Use the `azure_mariadb_servers` InSpec audit resource to test the properties and configuration of multiple Azure MariaDB Servers. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_mariadb_servers` resource block returns all Azure MariaDB Servers, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_mariadb_servers` resource block returns all Azure MariaDB Servers within a resource group (if provided) or the entire subscription. + ```ruby describe azure_mariadb_servers do #... end ``` -or + +Or + ```ruby -describe azure_mariadb_servers(resource_group: 'my-rg') do +describe azure_mariadb_servers(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -78,7 +81,11 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples @@ -87,38 +94,44 @@ end ```ruby describe azure_mariadb_servers do it { should exist } - its('names') { should include 'my-server-name' } + its('names') { should include 'MY-SERVER-NAME' } end ``` -**Filters the Results to Include Only Those Servers which Include the Given Name (Client Side Filtering).** + +### Filters the results to include only those servers that have the specified name (Client Side Filtering) ```ruby describe azure_mariadb_servers.where{ name.include?('production') } do it { should exist } end ``` -**Filters the Results to Include Only Those Servers which Reside in a Given Location (Client Side Filtering).** + +### Filters the results to include only those servers which reside in a specified location (Client Side Filtering) ```ruby describe azure_mariadb_servers.where{ location.eql?('westeurope') } do it { should exist } end -``` -**Filters the Results to Include Only Those Servers which Reside in a Given Location and Include the Given Name (Server Side Filtering - Recommended).** +``` + +### Filters the results to include only those servers which reside in a specified location and has the specified name (Server Side Filtering - Recommended) ```ruby describe azure_generic_resources(resource_provider: 'Microsoft.DBforMariaDB/servers', substring_of_name: 'production', location: 'westeurope') do - it {should exist} + it {should exist} end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby describe azure_mariadb_servers do it { should exist } @@ -127,4 +140,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_pricing.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_pricing.md new file mode 100644 index 0000000000..042158eec5 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_pricing.md @@ -0,0 +1,96 @@ ++++ +title = "azure_microsoft_defender_pricing Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_microsoft_defender_pricing" +identifier = "inspec/resources/azure/azure_microsoft_defender_pricing Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_microsoft_defender_pricing` Chef InSpec audit resource to test the properties of a Microsoft Defender for Cloud pricing configuration. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +```ruby +describe azure_microsoft_defender_pricing(name: 'DEFENDER_PRICING_NAME') do + it { should exist } +end +``` + +## Parameters + +`name` +: The name of the resource. + +## Properties + +`id` +: The ID of the resource. + +`name` +: The name of the resource. + +`type` +: The resource type. + +`properties.deprecated` +: True if the plan is deprecated. If there are replacing plans, they will appear in `replacedBy` property. + +`properties.freeTrialRemainingTime` +: The duration left for the subscriptions free trial period - in ISO 8601 format (e.g. P3Y6M4DT12H30M5S). + +`properties.pricingTier` +: The pricing tier value. Microsoft Defender for Cloud is provided in two pricing tiers: free and standard, with the standard tier available with a trial period. The standard tier offers advanced security capabilities, while the free tier offers basic security features. + +`properties.replacedBy` +: List of plans that replace this plan. This property exists only if this plan is deprecated. + +`properties.subPlan` +: The sub-plan selected for a Standard pricing configuration, when more than one sub-plan is available. Each sub-plan enables a set of security features. When not specified, full plan is applied. + +See the [Azure documentation on Defender for Cloud pricing configuration](https://learn.microsoft.com/en-us/rest/api/defenderforcloud/pricings/get) for additional information. You may access any attribute in the response with the key names separated by dots (`.`). + +## Examples + +### Test if a name exists + +This resource does not have any examples. + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +The control passes if the filter returns at least one result. + +```ruby +describe azure_microsoft_defender_pricing(name: 'DEFENDER_PRICING_NAME') do + it { should exist } +end +``` + +Use `should_not` if you expect zero matches. + +```ruby +describe azure_microsoft_defender_pricing(name: 'DEFENDER_PRICING_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +Graph resources require specific privileges granted to your service principal. Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_pricings.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_pricings.md new file mode 100644 index 0000000000..4599f06f34 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_pricings.md @@ -0,0 +1,105 @@ ++++ +title = "azure_microsoft_defender_pricings Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_microsoft_defender_pricings" +identifier = "inspec/resources/azure/azure_microsoft_defender_pricings Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_microsoft_defender_pricings` Chef InSpec audit resource to test the properties of multiple Microsoft Defender for Cloud pricing configurations. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +```ruby +describe azure_microsoft_defender_pricings do + #... +end +``` + +## Parameters + +No required parameters. + +## Properties + +`ids` +: The ID of the resource. + +: **Field**: `id` + +`names` +: The name of the resource. + +: **Field**: `name` + +`types` +: The type of the resource. + +: **Field**: `type` + +`freeTrialRemainingTimes` +: The duration left for the subscriptions free trial period - in ISO 8601 format (e.g. P3Y6M4DT12H30M5S). + +: **Field**: `properties.freeTrialRemainingTime` + +`pricingTiers` +: The pricing tier value. Microsoft Defender for Cloud is provided in two pricing tiers: free and standard, with the standard tier available with a trial period. The standard tier offers advanced security capabilities, while the free tier offers basic security features. + +: **Field**: `properties.pricingTier` + +`subPlans` +: The sub-plan selected for a Standard pricing configuration, when more than one sub-plan is available. Each sub-plan enables a set of security features. When not specified, full plan is applied. + +: **Field**: `properties.subPlan` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +See the [Azure documentation on Defender for Cloud pricing configuration](https://learn.microsoft.com/en-us/rest/api/defenderforcloud/pricings/list) for additional information. You may access any attribute in the response with the key names separated by dots (`.`). + +## Examples + +This resource does not have any examples. + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exist + +The control passes if the filter returns at least one result. + +```ruby +describe azure_microsoft_defender_pricings do + it { should exist } +end +``` + +Use `should_not` if you expect zero matches. + +```ruby +describe azure_microsoft_defender_pricings do + it { should_not exist } +end +``` + +## Azure Permissions + +Graph resources require specific privileges granted to your service principal. Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_security_contact.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_security_contact.md new file mode 100644 index 0000000000..fe7b9ae0a8 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_security_contact.md @@ -0,0 +1,119 @@ ++++ +title = "azure_microsoft_defender_security_contact Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_microsoft_defender_security_contact" +identifier = "inspec/resources/azure/azure_microsoft_defender_security_contact Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_microsoft_defender_security_contact` Chef InSpec audit resource to test the properties of a Microsoft Defender for Cloud Security Contact configuration. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +```ruby +describe azure_microsoft_defender_security_contact(name: 'SECURITY_CONTACT_NAME') do + it { should exist } +end +``` + +## Parameters + +`name` +: The name of the resource. + +## Properties + +`id` +: The ID of the resource. + +`name` +: The name of the resource. + +`type` +: The resource type. + +`properties.notificationsByRole.roles` +: Defines which RBAC roles will get email notifications from Microsoft Defender for Cloud. + +`properties.notificationsByRole.state` +: Defines whether to send email notifications from AMicrosoft Defender for Cloud to persons with specific RBAC roles on the subscription. + +`properties.emails` +: List of email addresses which will get notifications from Microsoft Defender for Cloud by the configurations defined in this security contact. + +`properties.phone` +: The security contact's phone number. + +`properties.alertNotifications.state` +: Defines if email notifications will be sent about new security alerts. + +`properties.alertNotifications.minimalSeverity` +: Defines the minimal alert severity which will be sent as email notifications. + +See the [Azure documentation on Defender for Cloud Security Contact configuration](https://learn.microsoft.com/en-us/rest/api/defenderforcloud/security-contacts/get?tabs=HTTP) for additional information. You may access any attribute in the response with the key names separated by dots (`.`). + +## Examples + +### Test if a name exists + +```ruby +describe azure_microsoft_defender_security_contact(name: 'SECURITY_CONTACT_NAME') do + its('name') { should eq 'SECURITY_CONTACT_NAME' } +end +``` + +### Test if a type exists + +```ruby +describe azure_microsoft_defender_security_contact(name: 'SECURITY_CONTACT_NAME') do + its('type') { should eq 'Microsoft.Security/securityContacts' } +end +``` + +### Test if a notification by role state exists + +```ruby +describe azure_microsoft_defender_security_contact(name: 'SECURITY_CONTACT_NAME') do + its('properties.notificationsByRole.state') { should eq 'On' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +The control passes if the filter returns at least one result. + +```ruby +describe azure_microsoft_defender_security_contact(name: 'SECURITY_CONTACT_NAME') do + it { should exist } +end +``` + +Use `should_not` if you expect zero matches. + +```ruby +describe azure_microsoft_defender_security_contact(name: 'SECURITY_CONTACT_NAME') do + it { should exist } +end +``` + +## Azure Permissions + +Graph resources require specific privileges granted to your service principal. Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_setting.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_setting.md new file mode 100644 index 0000000000..ba4d574a74 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_setting.md @@ -0,0 +1,79 @@ ++++ +title = "azure_microsoft_defender_setting Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_microsoft_defender_setting" +identifier = "inspec/resources/azure/azure_microsoft_defender_setting Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_microsoft_defender_setting` Chef InSpec audit resource to test the properties of a Microsoft Defender for Cloud Setting configuration. + +## Syntax + +```ruby +describe azure_microsoft_defender_setting(name: 'SETTING_NAME') do + it { should exist } +end +``` + +## Parameters + +`name` +: The name of the resource. + +## Properties + +`id` +: The ID of the resource. + +`name` +: The name of the resource. + +`kind` +: The resource kind. + +`type` +: The resource type. + +`properties.enabled` +: Is the alert sync setting enabled. + +See the [Azure documentation on Defender for Cloud Settings configuration](https://learn.microsoft.com/en-us/rest/api/defenderforcloud/settings/get?tabs=HTTP) for additional information. You may access any attribute in the response with the key names separated by dots (`.`). + +## Examples + +### Test if a name exists + +This resource does not have any examples. + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +The control passes if the filter returns at least one result. + +```ruby +describe azure_microsoft_defender_setting(name: 'SETTING_NAME') do + it { should exist } +end +``` + +Use `should_not` if you expect zero matches. + +```ruby +describe azure_microsoft_defender_setting(name: 'SETTING_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +Graph resources require specific privileges granted to your service principal. Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_settings.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_settings.md new file mode 100644 index 0000000000..9f673d6333 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_microsoft_defender_settings.md @@ -0,0 +1,92 @@ ++++ +title = "azure_microsoft_defender_settings Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_microsoft_defender_settings" +identifier = "inspec/resources/azure/azure_microsoft_defender_settings Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_microsoft_defender_settings` Chef InSpec audit resource to test the properties of multiple Microsoft Defender for Cloud Settings configurations. + +## Syntax + +```ruby +describe azure_microsoft_defender_settings do + it { should exist } +end +``` + +## Parameters + +No required parameters. + +## Properties + +`ids` +: The ID of the resource. + +: **Field**: `id` + +`names` +: The name of the resource. + +: **Field**: `name` + +`types` +: The type of the resource. + +: **Field**: `type` + +`kinds` +: The kind of the resource. + +: **Field**: `kind` + +`properties` +: The properties of the resource. + +: **Field**: `properties` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +See the [Azure documentation on Defender for Cloud Settings configuration](https://learn.microsoft.com/en-us/rest/api/defenderforcloud/settings/list?tabs=HTTP) for additional information. You may access any attribute in the response with the key names separated by dots (`.`). + +## Examples + +This resource does not have any examples. + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exist + +The control passes if the filter returns at least one result. + +```ruby +describe azure_microsoft_defender_settings do + it { should exist } +end +``` + +Use `should_not` if you expect zero matches. + +```ruby +describe azure_microsoft_defender_settings do + it { should_not exist } +end +``` + +## Azure Permissions + +Graph resources require specific privileges granted to your service principal. Please refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications#updating-an-application) for information on how to grant these permissions to your application. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment.md index c3328ab1af..2e74b63cf8 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_migrate_assessment Resource" parent = "inspec/resources/azure" +++ -Use the `azure_migrate_assessment` InSpec audit resource to test the properties related to Azure Migrate assessment. +Use the `azure_migrate_assessment` InSpec audit resource to test the properties related to the Azure Migrate assessment. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -44,7 +44,7 @@ end : Name of the Azure Migrate assessment to test. `resource_group` -: Azure resource group where the targeted resource resides in. +: Azure resource group where the targeted resource resides. `project_name` : Azure Migrate assessment project. @@ -52,9 +52,7 @@ end `group_name` : Unique name of a group within a project. -The parameter set should be provided for a valid query: - -- `resource_group`, `project_name`, `group_name`, and `name`. +The parameter set should be provided for a valid query are `resource_group`, `project_name`, `group_name`, and `name`. ## Properties @@ -77,7 +75,7 @@ The parameter set should be provided for a valid query: : Storage type selected for this disk. `properties.currency` -: Currency to report prices in. +: Currency to report the prices. `properties.sizingCriterion` : Assessment sizing criterion. @@ -91,7 +89,7 @@ Refer to the [Azure documentation](https://docs.microsoft.com/en-us/rest/api/mig ## Examples -**Test that the migrate assessments has a minimum scaling factor.** +### Test that the migrate assessments have a minimum scaling factor ```ruby describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do @@ -106,12 +104,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a Migrate Assessments is found, it will exist +# If a Migrate Assessment is found, it will exist. + describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do it { should exist } end +``` + +### not_exists + +```ruby +# If Migrate Assessments are not found, it will not exist. -# if Migrate Assessments are not found, it will not exist describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do it { should_not exist } end @@ -119,4 +123,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_group.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_group.md index 4095083019..c05aeeb786 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_group.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_group.md @@ -14,11 +14,11 @@ Use the `azure_migrate_assessment_group` InSpec audit resource to test the prope ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -44,14 +44,12 @@ end : Name of the Azure Migrate assessment group to test. `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `project_name` : Azure Migrate assessment project. -The parameter set should be provided for a valid query: - -- `resource_group`, `project_name`, and `name`. +The parameter set that should be provided for a valid query is `resource_group`, `project_name`, and `name`. ## Properties @@ -62,7 +60,7 @@ The parameter set should be provided for a valid query: : Name of the group. `type` -: Object type. `Microsoft.Migrate/assessmentProjects/groups`. +: Object type. `eTag` : For optimistic concurrency control. @@ -71,7 +69,7 @@ The parameter set should be provided for a valid query: : Properties of the group. `properties.areAssessmentsRunning` -: If the assessments are in running state. +: If the assessments are in a running state. `properties.assessments` : List of references to assessments created on this group. @@ -85,7 +83,7 @@ Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/m ## Examples -**Test the migrate assessment group has at least 5 machines.** +### Test the migrate assessment group has at least five machines ```ruby describe azure_migrate_assessment_group(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'GROUP_NAME') do @@ -100,11 +98,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a Migrate Assessment Group is found, it will exist +# If a Migrate Assessment Group is found, it will exist. + describe azure_migrate_assessment_group(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'GROUP_NAME') do it { should exist } end -# if Migrate Assessment Group is not found, it will not exist +``` + +### not_exists + +```ruby +# If Migrate Assessment Group is not found, it will not exist. + describe azure_migrate_assessment_group(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'GROUP_NAME') do it { should_not exist } end @@ -112,4 +117,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_groups.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_groups.md index 25167bf3b8..37a8a1ee0f 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_groups.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_groups.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_migrate_assessment_groups Resource" parent = "inspec/resources/azure" +++ -Use the `azure_migrate_assessment_groups` InSpec audit resource to test properties related to all Azure Migrate assessment groups within a project. +Use the `azure_migrate_assessment_groups` InSpec audit resource to test the properties related to all Azure Migrate assessment groups within a project. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -33,13 +33,12 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `project_name` : Azure Migrate assessment project. -The parameter set should be provided for a valid query: -- `resource_group` and `project_name`. +The parameter set that should be provided for a valid query is `resource_group` and `project_name`. ## Properties @@ -103,11 +102,15 @@ The parameter set should be provided for a valid query: : **Field**: `updatedTimestamp` -* For information on how to use filter criteria on plural resources refer to [FilterTable usage](https://github.com/inspec/inspec/blob/master/dev-docs/filtertable-usage.md). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/migrate/assessment/groups/list-by-project) for the complete list of properties available. +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through migrate assessment groups by their names.** +### Loop through migrate assessment groups by their names ```ruby azure_migrate_assessment_groups(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').names.each do |name| @@ -117,7 +120,7 @@ azure_migrate_assessment_groups(resource_group: 'RESOURCE_GROUP', project_name: end ``` -**Test that the assessments are running for migrate assessment groups.** +### Test that the assessments are running for migrating assessment groups ```ruby describe azure_migrate_assessment_groups(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where(areAssessmentsRunning: true) do @@ -127,17 +130,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Migrate Assessment Groups are present in the project +# Should not exist if no Migrate Assessment groups are present in the project. describe azure_migrate_assessment_groups(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do it { should_not exist } end -# Should exist if the filter returns at least one Migrate Assessment Groups in the project +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Migrate Assessment groups in the project. describe azure_migrate_assessment_groups(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do it { should exist } @@ -146,4 +156,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_machine.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_machine.md index eac1ea1437..ae2f480775 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_machine.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_machine.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_migrate_assessment_machine Resource" parent = "inspec/resources/azure" +++ -Use the `azure_migrate_assessment_machine` InSpec audit resource to test properties related to an Azure Migrate assessment machine. +Use the `azure_migrate_assessment_machine` InSpec audit resource to test the properties related to an Azure Migrate assessment machine. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`name`, `project_name` and `resource_group` are required parameters. +`name`, `project_name`, and `resource_group` are required parameters. ```ruby describe azure_migrate_assessment_machine(resource_group: 'RESOURCE_GROUP', project_name: 'MIGRATE_ASSESSMENT_PROJECT_NAME' name: 'MIGRATE_ASSESSMENT_MACHINE_NAME') do @@ -46,11 +46,11 @@ end `resource_group` _(required)_ -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `project_name` _(required)_ -: The Azure Migrate Assessment Project. +: The Azure Migrate Assessment project. ## Properties @@ -70,7 +70,7 @@ end : Properties of the assessment. `properties.bootType` -: Boot type of the machine. +: Boot type of machine. `properties.megabytesOfMemory` : Memory in Megabytes. @@ -79,17 +79,16 @@ end : Processor count. `properties.operatingSystemType` -: Operating System type of the machine. +: Operating system type of the machine. - -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/migrate/assessment/machines/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test the Boot Type of Migrate assessment machine.** +### Test the boot migrate assessment machine ```ruby describe azure_migrate_assessment_machine(resource_group: 'RESOURCE_GROUP', project_name: 'MIGRATE_ASSESSMENT_PROJECT_NAME', name: 'MIGRATE_ASSESSMENT_MACHINE_NAME') do @@ -104,13 +103,17 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a Migrate assessment machine is found it exists +# If a migrate assessment machine is found, it exists. describe azure_migrate_assessment_machine(resource_group: 'RESOURCE_GROUP', project_name: 'MIGRATE_ASSESSMENT_PROJECT_NAME' name: 'MIGRATE_ASSESSMENT_MACHINE_NAME') do it { should exist } end +``` -# if Migrate assessment machine is not found it does not exist +### not_exists + +```ruby +# If migrate assessment machine is not found, it does not exist. describe azure_migrate_assessment_machine(resource_group: 'RESOURCE_GROUP', project_name: 'MIGRATE_ASSESSMENT_PROJECT_NAME' name: 'MIGRATE_ASSESSMENT_MACHINE_NAME') do it { should_not exist } @@ -119,4 +122,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_machines.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_machines.md index e080ad66f8..f2ba493083 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_machines.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_machines.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_migrate_assessment_machines Resource" parent = "inspec/resources/azure" +++ -Use the `azure_migrate_assessment_machines` InSpec audit resource to test properties related to all Azure Migrate assessment machines within a project. +Use the `azure_migrate_assessment_machines` InSpec audit resource to test the properties related to all Azure Migrate assessment machines within a project. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -34,11 +34,11 @@ end `resource_group` _(required)_ -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `project_name` _(required)_ -: The Azure Migrate Assessment Project. +: The Azure Migrate Assessment project. ## Properties @@ -68,22 +68,22 @@ end : **Field**: `properties` `bootTypes` -: A list of boot type of the machines. +: A list of boot machines. : **Field**: `bootType` `createdTimestamps` -: Times when this machine was created. +: Time when this machine is created. : **Field**: `createdTimestamp` `datacenterManagementServerArmIds` -: A list of ARM IDs of the data center as tracked by the Microsoft.OffAzure. +: A list of ARM IDs of the data center as tracked by the `Microsoft.OffAzure`. : **Field**: `datacenterManagementServerArmId` `datacenterManagementServerNames` -: Name of the servers hosting the datacenter management solution. +: Name of the servers hosting the data center management solution. : **Field**: `datacenterManagementServerName` @@ -93,32 +93,32 @@ end : **Field**: `description` `discoveryMachineArmIds` -: A list of ARM IDs of the machine as tracked by the Microsoft.OffAzure. +: A list of ARM IDs of the machine as tracked by the `Microsoft.OffAzure`. : **Field**: `discoveryMachineArmId` `disks` -: Dictionary of disks attached to all the machines. Key is ID of disk. Value is a disk object. +: Dictionary of disks attached to all the machines. The key is disk ID. Value is a disk object. : **Field**: `disks` `displayNames` -: User readable names of all the machines as defined by the user in their private datacenter. +: User readable names of all the machines as defined by the user in their private data center. : **Field**: `displayName` `groups` -: A List of references to the groups that the machine is member of. +: A List of references to the groups where the machine is a member. : **Field**: `groups` `megabytesOfMemories` -: A list of Memories in Megabytes. +: A list of memories in Megabytes. : **Field**: `megabytesOfMemory` `networkAdapters` -: Dictionary of network adapters attached to all the machines. Key is ID of network adapter. Value is a network adapter object. +: Dictionary of network adapters attached to all the machines. The key is the network adapter ID. Value is a network adapter object. : **Field**: `networkAdapters` @@ -143,15 +143,19 @@ end : **Field**: `operatingSystemVersion` `updatedTimestamps` -: Time when the machines were last updated. +: Time when the machines are last updated. : **Field**: `updatedTimestamp` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through Migrate assessment machines by their names.** +### Loop through migrate assessment machines by their names ```ruby azure_migrate_assessment_machines(resource_group: 'RESOURCE_GROUP', project_name: 'MIGRATE_ASSESSMENT_PROJECT_NAME').names.each do |name| @@ -161,7 +165,7 @@ azure_migrate_assessment_machines(resource_group: 'RESOURCE_GROUP', project_name end ``` -**Test that there are Migrate assessment machines with BIOS boot type.** +### Test that there are migrate assessment machines with BIOS boot type ```ruby describe azure_migrate_assessment_machines(resource_group: 'RESOURCE_GROUP', project_name: 'MIGRATE_ASSESSMENT_PROJECT_NAME').where(bootType: 'BIOS') do @@ -171,18 +175,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Migrate assessment machines are present in the project and in the resource group +# Should not exist if no migrate assessment machines are present in the project and the resource group. describe azure_migrate_assessment_machines(resource_group: 'RESOURCE_GROUP', project_name: 'MIGRATE_ASSESSMENT_PROJECT_NAME') do it { should_not exist } end +``` + +### not_exists -# Should exist if the filter returns at least one Migrate assessment machines in the project and in the resource group +```ruby +# Should exist if the filter returns at least one migrate assessment machine in the project and the resource group. describe azure_migrate_assessment_machines(resource_group: 'RESOURCE_GROUP', project_name: 'MIGRATE_ASSESSMENT_PROJECT_NAME') do it { should exist } @@ -191,4 +201,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_project.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_project.md index 81d8b7e43c..f92eb9655a 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_project.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_project.md @@ -14,11 +14,11 @@ Use the `azure_migrate_assessment_project` InSpec audit resource to test the pro ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -41,14 +41,12 @@ end ## Parameters `name` -: Name of the Azure Migrate assessment Project to test. +: Name of the Azure Migrate assessment project to test. `resource_group` -: Azure resource group that the targeted project resides in. +: Azure resource group where the targeted project resides. -The parameter set should be provided for a valid query: - -- `resource_group` and `name`. +The parameter set that should be provided for a valid query is `resource_group` and `name`. ## Properties @@ -56,7 +54,7 @@ The parameter set should be provided for a valid query: : Path reference to the project. `name` -: Name of the project. +: Project name. `type` : Type of the object. @@ -68,13 +66,13 @@ The parameter set should be provided for a valid query: : Properties of the project. `location` -: Azure location in which project is created. +: Azure location in which the project is created. `properties.assessmentSolutionId` -: Assessment solution ARM id tracked by `Microsoft.Migrate/migrateProjects`. +: Assessment solution ARM ID tracked by `Microsoft.Migrate/migrateProjects`. `properties.customerStorageAccountArmId` -: The ARM ID of the storage account used for interactions when public access is disabled. +: The ARM ID of the storage account is used for interactions when public access is disabled. `properties.privateEndpointConnections` : The list of private endpoint connections to the project. @@ -91,7 +89,7 @@ Refer to the [Azure documentation](https://docs.microsoft.com/en-us/rest/api/mig ## Examples -**Test that the migrate assessment project has a minimum scaling factor.** +### Test that the migrate assessment project has a minimum scaling factor ```ruby describe azure_migrate_assessment_project(resource_group: 'RESOURCE_GROUP', name: 'ASSESSMENT_PROJECT_NAME') do @@ -106,12 +104,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a Migrate Assessment Project is found, it will exist +# If a Migrate Assessment project is found, it will exist. + describe azure_migrate_assessment_project(resource_group: 'RESOURCE_GROUP', name: 'ASSESSMENT_PROJECT_NAME') do it { should exist } end +``` + +### not_exists + +```ruby +# If Migrate Assessment project is not found, it will not exist. -# if Migrate Assessment Project is not found, it will not exist describe azure_migrate_assessment_project(resource_group: 'RESOURCE_GROUP', name: 'ASSESSMENT_PROJECT_NAME') do it { should_not exist } end @@ -119,4 +123,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_projects.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_projects.md index 01acaf935c..d3b3965859 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_projects.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessment_projects.md @@ -14,11 +14,11 @@ Use the `azure_migrate_assessment_projects` InSpec audit resource to test the pr ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -57,7 +57,7 @@ This resource does not require any parameters. : **Field**: `eTag` `locations` -: Azure locations in which project is created. +: Azure locations in which the project is created. : **Field**: `location` @@ -72,32 +72,32 @@ This resource does not require any parameters. : **Field**: `properties` `assessmentSolutionIds` -: Assessment solution ARM ids tracked by `Microsoft.Migrate/migrateProjects`. +: Assessment solution ARM IDs tracked by `Microsoft.Migrate/migrateProjects`. : **Field**: `assessmentSolutionId` `createdTimestamps` -: Times when this project was created. Date-Time represented in ISO-8601 format. +: Times when this project is created. Date-Time is represented in ISO-8601 format. : **Field**: `createdTimestamp` `customerStorageAccountArmIds` -: The ARM ids of the storage account used for interactions when public access is disabled. +: The ARM IDs of the storage account used for interactions when public access is disabled. : **Field**: `customerStorageAccountArmId` `customerWorkspaceIds` -: The ARM ids of service map workspace created by customer. +: The ARM IDs of the service map workspace created by customer. : **Field**: `customerWorkspaceId` `customerWorkspaceLocations` -: Locations of service map workspace created by customer. +: Locations of the service map workspace created by customer. : **Field**: `customerWorkspaceLocation` `lastAssessmentTimestamps` -: Times when last assessment is created. +: Times when the last assessment is created. : **Field**: `lastAssessmentTimestamp` @@ -132,12 +132,12 @@ This resource does not require any parameters. : **Field**: `provisioningState` `publicNetworkAccesses` -: Public Network Access for all the projects. +: Public network access for all the projects. : **Field**: `publicNetworkAccess` `serviceEndpoints` -: Service Endpoints of all the projects. +: Service endpoints of all the projects. : **Field**: `serviceEndpoint` @@ -146,11 +146,15 @@ This resource does not require any parameters. : **Field**: `updatedTimestamp` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through migrate assessment projects by their names.** +### Loop through migrate assessment projects by their names ```ruby azure_migrate_assessment_projects.names.each do |name| @@ -160,7 +164,7 @@ azure_migrate_assessment_projects.names.each do |name| end ``` -**Test to ensure that migrate assessment projects in West Europe location.** +### Test to ensure that migrate assessment projects in West Europe location ```ruby describe azure_migrate_assessment_projects.where(location: 'westeurope') do @@ -170,18 +174,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Migrate Assessment Projects are present in the subscription +# Should not exist if no Migrate Assessment projects are present in the subscription. describe azure_migrate_assessment_projects do it { should_not exist } end +``` + +### not_exists -# Should exist if the filter returns at least one Migrate Assessment Projects in the subscription +```ruby +# Should exist if the filter returns at least one Migrate Assessment project in the subscription. describe azure_migrate_assessment_projects do it { should exist } @@ -190,4 +200,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessments.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessments.md index bf5d02ca65..2867bfc091 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessments.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_assessments.md @@ -14,11 +14,11 @@ Use the `azure_migrate_assessments` InSpec audit resource to test the properties ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -33,13 +33,12 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `project_name` : Azure Migrate assessments project name. -The parameter set should be provided for a valid query: -- `resource_group` and `project_name` +The parameter set that should be provided for a valid query are `resource_group` and `project_name`. ## Properties @@ -74,7 +73,7 @@ The parameter set should be provided for a valid query: : **Field**: `azureDiskType` `azureHybridUseBenefits` -: AHUB discount on windows virtual machines of all the assessments. +: A HUB discount on windows virtual machines for all the assessments. : **Field**: `azureHybridUseBenefit` @@ -89,12 +88,12 @@ The parameter set should be provided for a valid query: : **Field**: `azureOfferCode` `azurePricingTiers` -: Pricing tiers for Size evaluation. +: Pricing tiers for size evaluation. : **Field**: `azurePricingTier` `azureStorageRedundancies` -: Storage Redundancy types offered by Azure. +: Storage redundancy types offered by Azure. : **Field**: `azureStorageRedundancy` @@ -114,17 +113,17 @@ The parameter set should be provided for a valid query: : **Field**: `createdTimestamp` `currencies` -: Currencies to report prices in. +: Currencies to report the prices. : **Field**: `currency` `discountPercentages` -: Custom discount percentages to be applied on final costs. +: Custom discount percentages to be applied to final costs. : **Field**: `discountPercentage` `eaSubscriptionIds` -: Enterprise agreement subscription arm ids. +: Enterprise agreement subscription arm IDs. : **Field**: `eaSubscriptionId` @@ -189,7 +188,7 @@ The parameter set should be provided for a valid query: : **Field**: `scalingFactor` `sizingCriterions` -: Assessment sizing criterions. +: Assessment sizing criteria. : **Field**: `sizingCriterion` @@ -199,7 +198,7 @@ The parameter set should be provided for a valid query: : **Field**: `stage` `statuses` -: Whether the assessments have been created and is valid. +: Whether the assessments have been created and are valid. : **Field**: `status` @@ -219,11 +218,16 @@ The parameter set should be provided for a valid query: : **Field**: `vmUptime` Refer to the [Azure Migrate assements documentation](https://docs.microsoft.com/en-us/rest/api/migrate/assessment/assessments/list-by-project) for additional information. -{{% inspec_filter_table %}} + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through migrate assessments by their names.** +### Loop through migrate assessments by their names ```ruby azure_migrate_assessments(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME'.names.each do |name| @@ -233,7 +237,7 @@ azure_migrate_assessments(resource_group: 'RESOURCE_GROUP', project_name: 'PROJE end ``` -**Test to ensure migrate assessments exist with local redundancy.** +### Test to ensure migrate assessments exist with local redundancy ```ruby describe azure_migrate_assessments(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where(azureStorageRedundancy: 'LocallyRedundant') do @@ -243,18 +247,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Migrate Assessments are present in the project and in the resource group +# Should not exist if no Migrate Assessments are present in the project and the resource group. describe azure_migrate_assessments(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do it { should_not exist } end +``` + +### not_exists -# Should exist if the filter returns at least one Migrate Assessment in the project and in the resource group +```ruby +# Should exist if the filter returns at least one Migrate Assessment in the project and the resource group. describe azure_migrate_assessments(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do it { should exist } @@ -263,4 +273,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project.md index 1521368832..a47fdbc318 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project.md @@ -10,25 +10,22 @@ identifier = "inspec/resources/azure/azure_migrate_project Resource" parent = "inspec/resources/azure" +++ -Use the `azure_migrate_project` InSpec audit resource to test properties related to an Azure Migrate Project. +Use the `azure_migrate_project` InSpec audit resource to test the properties related to an Azure Migrate project. ## Azure Rest API Version, Endpoint, and HTTP Client Parameters -This resource interacts with API versions supported by the resource provider. -The `api_version` can be defined as a resource parameter. -If not provided, the latest version will be used. -For more information, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md" >}}). +This resource interacts with API versions supported by the resource provider. The `api_version` can be defined as a resource parameter. +If not provided, the latest version will be used. For more information, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md" >}}). -Unless defined, `azure_cloud` global endpoint, and default values for the HTTP client will be used. -For more information, refer to the resource pack [README](https://github.com/inspec/inspec-azure/blob/main/README.md). +Unless defined, `azure_cloud` global endpoint and default values for the HTTP client will be used. For more information, refer to the resource pack [README](https://github.com/inspec/inspec-azure/blob/main/README.md). -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`name` and `resource_group` is a required parameter. +`name` and `resource_group` are required parameters. ```ruby describe azure_migrate_project(resource_group: 'RESOURCE_GROUP', name: 'PROJECT_NAME') do @@ -47,24 +44,23 @@ end ## Parameters `name` -: Name of the Azure migrate projectto test. +: Name of the Azure Migrate project to test. `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. -The parameter set should be provided for a valid query: -- `resource_group` and `name` +The parameter set that should be provided for a valid query is `resource_group` and `name`. ## Properties `id` -: Path reference to the Migrate Project. +: Path reference to the Migrate project. `eTag` : The eTag for concurrency control. `name` -: Unique name of an Migrate Project. +: Unique name of a Migrate project. `type` : Type of the object. `Microsoft.Migrate/MigrateProject`. @@ -72,14 +68,15 @@ The parameter set should be provided for a valid query: `properties` : The nested properties. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to the [Azure documentation](https://docs.microsoft.com/en-us/rest/api/migrate/projects/migrate-projects/get-migrate-project) for other available properties. -Any attribute in the response nested within properties may be accessed with the key names separated by dots (`.`) and attributes nested in the assessment data is pluralized and listed as collection. + +Any attribute in the response nested within properties may be accessed with the key names separated by dots (`.`), and attributes nested in the assessment data are pluralized and listed as a collection. ## Examples -**Test That The migrate projectHas Server Instance Type.** +### Test that The Migrate project has a server instance type ```ruby describe azure_migrate_project(resource_group: 'RESOURCE_GROUP', name: 'PROJECT_NAME') do @@ -94,13 +91,13 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a migrate projectis found it exists +# If a Migrate project is found, it exists. describe azure_migrate_project(resource_group: 'RESOURCE_GROUP', name: 'PROJECT_NAME') do it { should exist } end -# If migrate project is not found it does not exist +# If Migrate project is not found, it does not exist. describe azure_migrate_project(resource_group: 'RESOURCE_GROUP', name: 'PROJECT_NAME') do it { should_not exist } @@ -109,4 +106,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_database.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_database.md index d0d022776f..7125eaacf8 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_database.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_database.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_migrate_project_database Resource" parent = "inspec/resources/azure" +++ -Use the `azure_migrate_project_database` InSpec audit resource to test the properties related to an Azure Migrate project database. +Use the `azure_migrate_project_database` InSpec audit resource to test the properties related to an Azure Migrate Project database. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -45,14 +45,12 @@ end : Name of the Azure Migrate project database to test. `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `project_name` : Azure Migrate assessment project. -The parameter set should be provided for a valid query: - -- `resource_group`, `project_name`, and `name`. +The parameter set should be provided for a valid query are `resource_group`, `project_name`, and `name`. ## Properties @@ -72,7 +70,7 @@ The parameter set should be provided for a valid query: : Assessment details of the database published by various sources. `assessmentIds` -: The database assessment scope/Ids. +: The database assessment scope/IDs. `migrationBlockersCounts` : The number of blocking changes found. @@ -87,18 +85,18 @@ The parameter set should be provided for a valid query: : The names of the solutions that sent the data. `instanceIds` -: The database servers' instance Ids. +: The database servers' instance IDs. `databaseNames` : The name of the databases. For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/migrate/projects/databases/get-database) for other properties available. Any attribute in the response nested within properties is accessed with the key names separated by dots (`.`) and attributes nested in the assessmentData are pluralized and listed as a collection. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/migrate/projects/databases/get-database) for other properties available. Any attribute in the response nested within properties is accessed with the key names separated by dots (`.`), and attributes nested in the assessmentData are pluralized and listed as a collection. ## Examples -**Test that migrate project database has a SQL assessmentTargetType.** +### Test that Migrate Project database has a SQL 'assessmentTargetType' ```ruby describe azure_migrate_project_database(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_DB_NAME') do @@ -113,12 +111,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a Migrate Project Database is found, it will exist +# If a Migrate Project database is found, it will exist. + describe azure_migrate_project_database(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_DB_NAME') do it { should exist } end +``` + +### not_exists + +```ruby +# if Migrate Project Database is not found, it will not exist. -# if Migrate Project Database is not found, it will not exist describe azure_migrate_project_database(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_DB_NAME') do it { should_not exist } end @@ -126,4 +130,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_database_instance.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_database_instance.md index 4e0bbff39c..2f20259a7b 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_database_instance.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_database_instance.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_migrate_project_database_instance Res parent = "inspec/resources/azure" +++ -Use the `azure_migrate_project_database_instance` InSpec audit resource to test properties of a single Azure Migrate project database instance. +Use the `azure_migrate_project_database_instance` InSpec audit resource to test the properties of a single Azure Migrate Project database instance. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -39,14 +39,13 @@ end ## Parameters - `name` _(required)_ : Unique name of a database in Azure migration hub. `resource_group` _(required)_ -: Name of the Azure Resource Group that migrate project is part of. +: Name of the Azure Resource Group where the migrate project is part. `project_name` _(required)_ @@ -73,7 +72,7 @@ end : The database instances summary per solution. `enqueueTimes` -: The times the message were enqueued. +: The time when the message was enqueued. `extendedInfos` : The extended properties of the database server. @@ -105,15 +104,15 @@ end `solutionNames` : The names of the solution that sent the data. - -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/migrate/projects/databases/get-database) for other properties available. -Any attribute in the response nested within properties may be accessed with the key names separated by dots (`.`) and attributes nested in the assessment data is pluralized and listed as collection. + +Any attribute in the response nested within properties may be accessed with the key names separated by dots (`.`), and attributes nested in the assessment data is pluralized and listed as a collection. ## Examples -**Test that the Migrate project database instance has a SQL instanceType.** +### Test that the Migrate Project database instance has a SQL instanceType ```ruby describe azure_migrate_project_database_instance(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'DB_NAME') do @@ -128,12 +127,17 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a Migrate project database instance is found it will exist +# If a Migrate Project database instance is found, it will exist. describe azure_migrate_project_database_instance(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'DB_NAME') do it { should exist } end -# if Migrate project database instance is not found it will not exist +``` + +### not_exists + +```ruby +# If Migrate Project database instance is not found, it will not exist. describe azure_migrate_project_database_instance(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'DB_NAME') do it { should_not exist } @@ -142,4 +146,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_database_instances.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_database_instances.md index 170eb6aa20..b1e73d708f 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_database_instances.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_database_instances.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_migrate_project_database_instances Re parent = "inspec/resources/azure" +++ -Use the `azure_migrate_project_database_instances` InSpec audit resource to test properties of all Azure Migrate project database instances in a migrate project. +Use the `azure_migrate_project_database_instances` InSpec audit resource to test the properties of all Azure Migrate Project database instances in a migrate project. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -34,7 +34,7 @@ end `resource_group` _(required)_ -: Name of the Azure Resource Group that migrate project is part of. +: Name of the Azure Resource Group where the migrate project is part. `project_name` _(required)_ @@ -78,7 +78,7 @@ end : **Field**: `lastUpdatedTime` `enqueueTimes` -: The times the message were enqueued. +: The time when the message was enqueued. : **Field**: `enqueueTimes` @@ -127,11 +127,15 @@ end : **Field**: `solutionNames` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through Migrate project database instances by their names.** +### Loop through Migrate Project database instances by their names ```ruby azure_migrate_project_database_instances(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').names.each do |name| @@ -141,7 +145,7 @@ azure_migrate_project_database_instances(resource_group: 'RESOURCE_GROUP', proje end ``` -**Test that there are Migrate project database instances that are of SQL instance types.** +### Test that there are Migrate Project database instances that are of SQL instance types ```ruby describe azure_migrate_project_database_instances(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where{ instanceTypes.include?('SQL') } do @@ -151,17 +155,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Migrate project database instances are present in the project and in the resource group +# Should not exist if no Migrate Project database instances are present in the project and the resource group. describe azure_migrate_project_database_instances(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do it { should_not exist } end -# Should exist if the filter returns at least one Migrate project database instances in the project and in the resource group +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Migrate project database instance in the project and the resource group. describe azure_migrate_project_database_instances(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do it { should exist } @@ -170,4 +181,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_databases.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_databases.md index a61297e3b6..45e9f91593 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_databases.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_databases.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_migrate_project_databases Resource" parent = "inspec/resources/azure" +++ -Use the `azure_migrate_project_databases` InSpec audit resource to test the properties of all Azure Migrate project databases within a project. +Use the `azure_migrate_project_databases` InSpec audit resource to test the properties of all Azure Migrate Project databases within a project. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_migrate_project_databases` resource block returns all Azure Migrate project databases within a project. +An `azure_migrate_project_databases` resource block returns all Azure Migrate Project databases within a project. ```ruby describe azure_migrate_project_databases(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do @@ -33,14 +33,12 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `project_name` : Azure Migrate Project. -The parameter set should be provided for a valid query: - -- `resource_group` and `project_name`. +The parameter set should be provided for a valid query is`resource_group` and `project_name`. ## Properties @@ -70,7 +68,7 @@ The parameter set should be provided for a valid query: : **Field**: `assessmentData` `assessmentIds` -: The database assessment scopes/Ids. +: The database assessment scopes/IDs. : **Field**: `assessmentId` @@ -110,7 +108,7 @@ The parameter set should be provided for a valid query: : **Field**: `extendedInfo` `instanceIds` -: The database server instance Ids. +: The database server instance IDs. : **Field**: `instanceId` @@ -139,11 +137,15 @@ The parameter set should be provided for a valid query: : **Field**: `solutionName` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through Migrate project databases by their names.** +### Loop through Migrate Project databases by their names ```ruby azure_migrate_project_databases(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').names.each do |name| @@ -153,7 +155,7 @@ azure_migrate_project_databases(resource_group: 'RESOURCE_GROUP', project_name: end ``` -**Test there are Migrate project databases are ready for migration.** +### Test there are Migrate Project databases are ready for migration ```ruby describe azure_migrate_project_databases(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where{ isReadyForMigration.include?(true) } do @@ -163,18 +165,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Migrate project databases are present in the project and in the resource group +# Should not exist if no Migrate Project databases are present in the project and the resource group. describe azure_migrate_project_databases(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do it { should_not exist } end +``` + +### not_exists -# Should exist if the filter returns at least one Migrate project databases in the project and in the resource group +```ruby +# Should exist if the filter returns at least one Migrate project databases in the project and the resource group. describe azure_migrate_project_databases(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do it { should exist } @@ -183,4 +191,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_event.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_event.md index b9a56c45a4..9121e45e9f 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_event.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_event.md @@ -14,15 +14,15 @@ Use the `azure_migrate_project_event` InSpec audit resource to test the properti ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group`, `project_name` and `name` are required parameters. +`resource_group`, `project_name`, and `name` are required parameters. ```ruby describe azure_migrate_project_event(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_EVENT_NAME') do @@ -40,17 +40,15 @@ end ## Parameters `name` -: Name of the Azure Migrate project event to test. +: Name of the Azure Migrate Project event to test. `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `project_name` -: Azure Migrate assessment project name. +: Azure Migrate Assessment Project name. -The parameter set should be provided for a valid query: - -- `resource_group`, `project_name`, and `name`. +The parameter set should be provided for a valid query is `resource_group`, `project_name`, and `name`. ## Properties @@ -74,7 +72,7 @@ Any attribute in the response nested within properties is accessed with the key ## Examples -**Test that the migrate project event is of servers instanceType.** +### Test that the Migrate project event is of servers 'instanceType' ```ruby describe azure_migrate_project_event(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_EVENT_NAME') do @@ -89,11 +87,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a migrate project event is found, it will exist +# If a migrate project event is found, it will exist. + describe azure_migrate_project_event(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_EVENT_NAME') do it { should exist } end -# if migrate project event is not found, it will not exist +``` + +### not_exists + +```ruby +# if migrate project event is not found, it will not exist. + describe azure_migrate_project_event(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_EVENT_NAME') do it { should_not exist } end @@ -101,4 +106,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_events.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_events.md index d6932829ca..1771319eb9 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_events.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_events.md @@ -14,11 +14,11 @@ Use the `azure_migrate_project_events` InSpec audit resource to test the propert ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -33,14 +33,12 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `project_name` : Azure Migrate Project. -The parameter set should be provided for a valid query: - -- `resource_group` and `project_name`. +The parameter set that should be provided for a valid query is `resource_group` and `project_name`. ## Properties @@ -100,17 +98,21 @@ The parameter set should be provided for a valid query: : **Field**: `solution` `clientRequestIds` -: The client request Ids of the payload for which the event is reported. +: The client request IDs of the payload for which the event is reported. : **Field**: `clientRequestId` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} For more details on the available properties, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/migrate/projects/events/enumerate-events). ## Examples -**Loop through migrate project events by their names.** +### Loop through Migrate Project events by their names ```ruby azure_migrate_project_events(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').names.each do |name| @@ -120,7 +122,7 @@ azure_migrate_project_events(resource_group: 'RESOURCE_GROUP', project_name: 'PR end ``` -**Test that there are migrate project events for databases.** +### Test that there are Migrate Project events for databases ```ruby describe azure_migrate_project_events(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where(instanceType: 'Databases') do @@ -130,16 +132,25 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -### exists +This resource has the following special matchers. + +### not_exists ```ruby -# Should not exist, if no migrate project events are present in the project and in the resource group +# Should not exist if no migrate project events are present in the project and the resource group. + describe azure_migrate_project_events(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do it { should_not exist } end -# Should exist, if the filter returns at least one migrate project events in the project and in the resource group +``` + +### exists + +```ruby +# Should exist if the filter returns at least one migrate project event in the project and the resource group. + describe azure_migrate_project_events(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do it { should exist } end @@ -147,4 +158,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_machine.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_machine.md index 250fe60ff1..0c72b5c308 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_machine.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_machine.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_migrate_project_machine Resource" parent = "inspec/resources/azure" +++ -Use the `azure_migrate_project_machine` InSpec audit resource to test the properties related to an Azure Migrate project machine. +Use the `azure_migrate_project_machine` InSpec audit resource to test the properties related to an Azure Migrate Project machine. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group`, `project_name` and `name` are required parameters. +`resource_group`, `project_name`, and `name` are required parameters. ```ruby describe azure_migrate_project_machine(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_MACHINE_NAME') do @@ -41,25 +41,23 @@ end ## Parameters `name` -: Name of the Azure Migrate project machine to test. +: Name of the Azure Migrate Project machine to test. `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `project_name` -: Azure Migrate assessment project name. +: Azure Migrate Assessment Project name. -The parameter set must be provided for a valid query: - -- `resource_group`, `project_name`, and `name`. +The parameter set that must be provided for a valid query is `resource_group`, `project_name`, and `name`. ## Properties `id` -: Path reference to the Migrate project machine. +: Path reference to the Migrate Project machine. `name` -: Unique name of a Migrate project machine. +: Unique name of a Migrate Project machine. `type` : Type of the object. `Microsoft.Migrate/MigrateProjects/Databases`. @@ -81,11 +79,13 @@ The parameter set must be provided for a valid query: For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/migrate/projects/machines/get-machine) for other properties available. Any attribute in the response nested within properties may be accessed with the key names separated by dots (`.`), and attributes nested in the **assessmentData** are pluralized and listed as a collection. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/migrate/projects/machines/get-machine) for other properties available. + +Any attribute in the response nested within properties may be accessed with the key names separated by dots (`.`), and attributes nested in the **assessmentData** are pluralized and listed as a collection. ## Examples -**Test that the migrate project machine has a Windows OS.** +### Test that the Migrate Project machine has a Windows OS ```ruby describe azure_migrate_project_machine(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_MACHINE_NAME') do @@ -100,11 +100,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a migrate project machine is found, it will exist +# If a migrate project machine is found, it will exist. + describe azure_migrate_project_machine(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_MACHINE_NAME') do it { should exist } end -# if migrate project machine is not found, it will not exist +``` + +### not_exists + +```ruby +# If migrate project machine is not found, it will not exist. + describe azure_migrate_project_machine(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_MACHINE_NAME') do it { should_not exist } end @@ -112,4 +119,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_machines.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_machines.md index a8399f04bc..d51257c36e 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_machines.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_machines.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_migrate_project_machines Resource" parent = "inspec/resources/azure" +++ -Use the `azure_migrate_project_machines` InSpec audit resource to test the properties related to all Azure Migrate project machines within a project. +Use the `azure_migrate_project_machines` InSpec audit resource to test the properties related to all Azure Migrate Project machines within a project. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_migrate_project_machines` resource block returns all Azure Migrate project machines within a project. +An `azure_migrate_project_machines` resource block returns all Azure Migrate Project machines within a project. ```ruby describe azure_migrate_project_machines(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do @@ -33,13 +33,12 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `project_name` : Azure Migrate project name. -The parameter set should be provided for a valid query: -- `resource_group` and `project_name`. +The parameter set that should be provided for a valid query is `resource_group` and `project_name`. ## Properties @@ -64,17 +63,17 @@ The parameter set should be provided for a valid query: : **Field**: `properties` `discoveryData` -: The discovery details of all the machine published by various sources. +: The discovery details of all the machines published by various sources. : **Field**: `discoveryData` `assessmentData` -: The assessment details of all the machine published by various sources. +: The assessment details of all the machines published by various sources. : **Field**: `assessmentData` `migrationData` -: The migration details of all the machine published by various sources. +: The migration details of all the machines published by various sources. : **Field**: `migrationData` @@ -83,11 +82,15 @@ The parameter set should be provided for a valid query: : **Field**: `lastUpdatedTime` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through migrate project machines by their names.** +### Loop through Migrate Project machines by their names ```ruby azure_migrate_project_machines(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').names.each do |name| @@ -97,7 +100,7 @@ azure_migrate_project_machines(resource_group: 'RESOURCE_GROUP', project_name: ' end ``` -**Test that there are migrate project machines with Windows OS.** +### Test that there are Migrate Project machines with Windows OS ```ruby describe azure_migrate_project_machines(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where{ discoveryData.detect{ |data| data[:osType] == 'WINDOWSGUEST' } } do @@ -105,7 +108,7 @@ describe azure_migrate_project_machines(resource_group: 'RESOURCE_GROUP', projec end ``` -**Test that the migrate project machines is of BIOS boot type.** +### Test that the Migrate Project machines are of BIOS boot type ```ruby describe azure_migrate_project_machines(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where{ discoveryData.detect{ |data| data[:extendedInfo][:bootType] == 'BIOS' } } do @@ -115,16 +118,25 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist, if no migrate project machines are present in the project and in the resource group +# Should not exist if no Migrate Project machines are present in the project and the resource group. + describe azure_migrate_project_machines(resource_group: 'migrate_vms', project_name: 'zoneA_migrate_project') do it { should_not exist } end -# Should exist, if the filter returns at least one migrate project machines in the project and in the resource group +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Migrate Project machine in the project and the resource group. + describe azure_migrate_project_machines(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do it { should exist } end @@ -132,4 +144,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_solution.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_solution.md index e3739068aa..7041712665 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_solution.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_solution.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_migrate_project_solution Resource" parent = "inspec/resources/azure" +++ -Use the `azure_migrate_project_solution` InSpec audit resource to test the properties related to an Azure Migrate Project Solution. +Use the `azure_migrate_project_solution` InSpec audit resource to test the properties related to an Azure Migrate Project solution. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -44,14 +44,12 @@ end : Name of the Azure Migrate project solution to test. `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `project_name` : Azure Migrate project. -The parameter set should be provided for a valid query: - -- `resource_group`, `project_name`, and `name`. +The parameter set should be provided for a valid query is`resource_group`, `project_name`, and `name`. ## Properties @@ -88,7 +86,7 @@ Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/m ## Examples -**Test that the migrate project solution is defined for assessment.** +### Test that the Migrate Project solution is defined for assessment ```ruby describe azure_migrate_project_solution(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_SOLUTION_NAME') do @@ -103,12 +101,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a Migrate Project Solution is found, it will exist +# If a Migrate Project solution is found, it will exist. + describe azure_migrate_project_solution(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_SOLUTION_NAME') do it { should exist } end +``` + +### not_exists + +```ruby +# If Migrate Project solutions are not found, it will not exist. -# if Migrate Project Solution are not found, it will not exist describe azure_migrate_project_solution(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', name: 'PROJECT_SOLUTION_NAME') do it { should_not exist } end @@ -116,4 +120,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_solutions.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_solutions.md index 55d3895431..9d286969be 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_solutions.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_migrate_project_solutions.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_migrate_project_solutions Resource" parent = "inspec/resources/azure" +++ -Use the `azure_migrate_project_solutions` InSpec audit resource to test the properties related to all Azure Migrate project solutions within a project. +Use the `azure_migrate_project_solutions` InSpec audit resource to test the properties related to all Azure Migrate Project solutions within a project. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_migrate_project_solutions` resource block returns all Azure Migrate project solutions within a project. +An `azure_migrate_project_solutions` resource block returns all Azure Migrate Project solutions within a project. ```ruby describe azure_migrate_project_solutions(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do @@ -33,14 +33,12 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `project_name` : Azure Migrate Project. -The parameter set should be provided for a valid query: - -- `resource_group` and `project_name`. +The parameter set that should be provided for a valid query is `resource_group` and `project_name`. ## Properties @@ -60,12 +58,12 @@ The parameter set should be provided for a valid query: : **Field**: `type` `eTags` -: A list of eTags for all the Project Solutions. +: A list of eTags for all the project solutions. : **Field**: `eTag` `properties` -: A list of Properties for all the Project Solutions. +: A list of properties for all the project solutions. : **Field**: `properties` @@ -139,11 +137,15 @@ The parameter set should be provided for a valid query: : **Field**: `extendedDetails` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through migrate project solutions by their names.** +### Loop through Migrate Project solutions by their names ```ruby azure_migrate_project_solutions(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').names.each do |name| @@ -153,7 +155,7 @@ azure_migrate_project_solutions(resource_group: 'RESOURCE_GROUP', project_name: end ``` -**Test to ensure the migrate project solutions for assessment.** +### Test to ensure the Migrate Project solutions for assessment ```ruby describe azure_migrate_project_solutions(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where(purpose: 'Assessment') do @@ -163,17 +165,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -### exists +This resource has the following special matchers. + +### not_exists ```ruby -# Should not exist if no Migrate Project Solutions are present in the project and in the resource group +# Should not exist if no Migrate Project solutions are present in the project and the resource group. describe azure_migrate_project_solutions(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do it { should_not exist } end -# Should exist if the filter returns at least one Migrate Project Solutions in the project and in the resource group +``` + +### exists + +```ruby +# Should exist if the filter returns at least one Migrate Project solution in the project and the resource group. describe azure_migrate_project_solutions(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do it { should exist } @@ -182,4 +191,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_activity_log_alert.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_activity_log_alert.md index 1f293834e4..449074b2cf 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_activity_log_alert.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_activity_log_alert.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_monitor_activity_log_alert Resource" parent = "inspec/resources/azure" +++ -Use the `azure_monitor_activity_log_alert` InSpec audit resource to test properties of an Azure Monitor Activity Log Alert. +Use the `azure_monitor_activity_log_alert` InSpec audit resource to test the properties of an Azure Monitor Activity Log Alert. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_monitor_activity_log_alert` resource block identifies an Azure Monitor Activity Log Alert by `name` and `resource_group` or the `resource_id`. +An `azure_monitor_activity_log_alert` resource block identifies an Azure Monitor Activity Log Alert by `name` and `resource_group`, or the `resource_id`. + ```ruby -describe azure_monitor_activity_log_alert(resource_group: 'example', name: 'AlertName') do +describe azure_monitor_activity_log_alert(resource_group: 'RESOURCE_GROUP', name: 'ALERT_NAME') do it { should exist } end ``` + ```ruby describe azure_monitor_activity_log_alert(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/activityLogAlerts/{activityLogAlertName}') do it { should exist } @@ -37,15 +39,16 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: Name of the Activity Log Alert to test. `AlertName`. +: Name of the Activity Log Alert to test. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/activityLogAlerts/{activityLogAlertName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` @@ -58,29 +61,31 @@ Either one of the parameter sets can be provided for a valid query: : The list of activity log alert conditions that will cause this alert to activate. `scopes` -: A list of resource id prefixes. The alert will only apply to activityLogs with resource ids that fall under one of these prefixes. +: A list of resource ID prefixes. The alert will only apply to activity logs with resource IDs that fall under one of these prefixes. `enabled?` -: Indicates whether this activity log alert is enabled. `true` or `false`. +: Indicates whether this activity log alert is enabled. Valid values are `true` or `false`. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/monitor/activitylogalerts/get#activitylogalertresource) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/monitor/activitylogalerts/get#activitylogalertresource) for other properties available. + +Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test an Activity Log Alert Has the Correct Operation.** +### Test an Activity Log Alert has the correct operation ```ruby -describe azure_monitor_activity_log_alert(resource_group: 'example', name: 'AlertName') do +describe azure_monitor_activity_log_alert(resource_group: 'RESOURCE_GROUP', name: 'ALERT_NAME') do its('operations') { should include 'Microsoft.Authorization/policyAssignments/write' } end ``` -**Test the Scope of an Activity Log Alert.** + +### Test the scope of an Activity Log Alert ```ruby -describe azure_monitor_activity_log_alert(resource_group: 'example', name: 'AlertName') do +describe azure_monitor_activity_log_alert(resource_group: 'RESOURCE_GROUP', name: 'ALERT_NAME') do its('scopes') { should include 'subscriptions/{SUBSCRIPTION_ID}' } end ``` @@ -92,27 +97,33 @@ This InSpec audit resource has the following special matchers. For a full list o ### enabled Test if a resource is enabled. If an activity log alert is not enabled, then none of its actions will be activated. + ```ruby -describe azure_monitor_activity_log_alert(resource_group: 'example', name: 'AlertName') do +describe azure_monitor_activity_log_alert(resource_group: 'RESOURCE_GROUP', name: 'ALERT_NAME') do it { should be_enabled } end ``` + ### exists ```ruby -# If we expect a resource to always exist +# If we expect a resource to always exist. -describe azure_monitor_activity_log_alert(resource_group: 'example', name: 'AlertName') do +describe azure_monitor_activity_log_alert(resource_group: 'RESOURCE_GROUP', name: 'ALERT_NAME') do it { should exist } end +``` -# If we expect a resource to never exist +### not_exists + +```ruby +# If we expect a resource to never exist. -describe azure_monitor_activity_log_alert(resource_group: 'example', name: 'AlertName') do +describe azure_monitor_activity_log_alert(resource_group: 'RESOURCE_GROUP', name: 'ALERT_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_activity_log_alerts.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_activity_log_alerts.md index c5d4dc9b40..16444ccaf4 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_activity_log_alerts.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_activity_log_alerts.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_monitor_activity_log_alerts Resource" parent = "inspec/resources/azure" +++ -Use the `azure_monitor_activity_log_alerts` InSpec audit resource to test properties and configuration of multiple Azure Monitor activity log alerts. +Use the `azure_monitor_activity_log_alerts` InSpec audit resource to test the properties and configuration of multiple Azure Monitor Activity Log Alerts. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_monitor_activity_log_alerts` resource block returns all activity log alerts, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_monitor_activity_log_alerts` resource block returns all activity log alerts within a resource group (if provided) or an entire subscription. ```ruby describe azure_monitor_activity_log_alerts do @@ -30,10 +30,10 @@ describe azure_monitor_activity_log_alerts do end ``` -or +Or ```ruby -describe azure_monitor_activity_log_alerts(resource_group: 'my-rg') do +describe azure_monitor_activity_log_alerts(resource_group: 'RESOURCE_GROUP') do it { should exist } end ``` @@ -47,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -72,15 +72,19 @@ end : **Field**: `operations` `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. : **Field**: `resource_group` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test that a subscription has the named activity log alert.** +### Test that a subscription has the named activity log alert ```ruby describe azure_monitor_activity_log_alerts do @@ -100,24 +104,32 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. ```ruby -# If we expect 'ExampleGroup' Resource Group to have activity log alerts -describe azure_monitor_activity_log_alerts(resource_group: 'ExampleGroup') do +# If we expect 'EXAMPLEGROUP' resource group to have activity log alerts. + +describe azure_monitor_activity_log_alerts(resource_group: 'EXAMPLEGROUP') do it { should exist } end +``` + +### not_exists + +```ruby +# If we expect 'EMPTYEXAMPLEGROUP' resource group not to have activity log alerts. -# If we expect 'EmptyExampleGroup' Resource Group to not have activity log alerts -describe azure_monitor_activity_log_alerts(resource_group: 'ExampleGroup') do +describe azure_monitor_activity_log_alerts(resource_group: 'EMPTYEXAMPLEGROUP') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_log_profile.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_log_profile.md index 32e37656d2..c9d57587cb 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_log_profile.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_log_profile.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_monitor_log_profile Resource" parent = "inspec/resources/azure" +++ -Use the `azure_monitor_log_profile` InSpec audit resource to test properties and configuration of an Azure log profile. +Use the `azure_monitor_log_profile` InSpec audit resource to test the properties and configuration of an Azure Log profile. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`name` or the `resource_id` must be given as a parameter. +`name` or the `resource_id` are required parameters. + ```ruby -describe azure_monitor_log_profile(name: 'my_log_profile') do +describe azure_monitor_log_profile(name: 'LOG_PROFILE') do it { should exist } end ``` + ```ruby describe azure_monitor_log_profile(resource_id: '/subscriptions/{subscriptionId}/providers/microsoft.insights/logprofiles/{logProfileName}') do it { should exist } @@ -37,10 +39,10 @@ end ## Parameters `name` -: Name of the log profile to test. `logProfileName`. +: Name of the log profile to test. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/providers/microsoft.insights/logprofiles/{logProfileName}`. +: The unique resource ID. ## Properties @@ -53,51 +55,58 @@ end `storage_account` : A hash containing the `name` and the `resouce_group` of the storage account in which the activity logs are kept. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/monitor/logprofiles/get#logprofileresource) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/monitor/logprofiles/get#logprofileresource) for other properties available. + +Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test If a Log Profile is Referenced with a Valid Name.** +### Test if a Log profile is referenced with a valid name ```ruby -describe azure_monitor_log_profile(name: 'my_log_profile') do +describe azure_monitor_log_profile(name: 'LOG_PROFILE') do it { should exist } end ``` -**Test If a Log Profile is Referenced with an Invalid Name.** + +### Test if a Log profile is referenced with an invalid name ```ruby describe azure_monitor_log_profile(name: 'i-dont-exist') do it { should_not exist } end -``` -**Test the Retention Days of a Log Profile.** +``` + +### Test the retention days of a Log profile ```ruby -describe azure_monitor_log_profile(name: 'my_log_profile') do +describe azure_monitor_log_profile(name: 'LOG_PROFILE') do its('retention_days') { should be 90 } end -``` -**Test the Storage Account of a Log Profile.** +``` + +### Test the storage account of a Log profile ```ruby describe azure_monitor_log_profile(resource_id: '/subscriptions/{subscriptionId}/providers/microsoft.insights/logprofiles/{logProfileName}') do - its('storage_account') { should eql(resource_group: 'InSpec_rg', name: 'my_storage_account') } + its('storage_account') { should eql(resource_group: 'RESOURCE_GROUP', name: 'STORAGE_ACCOUNT') } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### have_log_retention_enabled Test whether the log retention is enabled. + ```ruby -describe azure_monitor_log_profile(name: 'my_log_profile') do +describe azure_monitor_log_profile(name: 'LOG_PROFILE') do it { should have_log_retention_enabled } end ``` @@ -105,18 +114,23 @@ end ### exists ```ruby -# If we expect a resource to always exist +# If we expect a resource to always exist. -describe azure_monitor_log_profile(name: 'my_log_profile') do +describe azure_monitor_log_profile(name: 'LOG_PROFILE') do it { should exist } end -# If we expect a resource to never exist +``` + +### not_exists + +```ruby +# If we expect a resource to never exist. -describe azure_monitor_log_profile(name: 'my_log_profile') do +describe azure_monitor_log_profile(name: 'LOG_PROFILE') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_log_profiles.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_log_profiles.md index a780ea118e..0c5f0e8fbf 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_log_profiles.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_monitor_log_profiles.md @@ -10,19 +10,20 @@ identifier = "inspec/resources/azure/azure_monitor_log_profiles Resource" parent = "inspec/resources/azure" +++ -Use the `azure_monitor_log_profiles` InSpec audit resource to test properties and configuration of multiple Azure log profiles. +Use the `azure_monitor_log_profiles` InSpec audit resource to test the properties and configuration of multiple Azure Log profiles. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_monitor_log_profiles` resource block returns all Azure log profiles within an entire subscription. +An `azure_monitor_log_profiles` resource block returns all Azure Log profiles within an entire subscription. + ```ruby describe azure_monitor_log_profiles do it { should exist } @@ -36,7 +37,7 @@ This resource does not require any parameters. ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -50,40 +51,49 @@ This resource does not require any parameters. : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check if a Specific Log Profile is Present.** +### Check if a specific Log profile is present ```ruby describe azure_monitor_log_profiles do - its('names') { should include 'my_log_profile' } + its('names') { should include 'LOG_PROFILE' } end ``` -**Filter the Results by the `name` Property if it Includes a Certain String.** + +### Filter the results by the 'name' property if it includes a certain string ```ruby describe azure_monitor_log_profiles.where{ name.include?('production') } do it { should exist } end -``` -**Filter the Results to Include Only Those Log Profiles that Retention Policy is Enabled.** +``` + +### Filter the results to include only those Log profiles that retention policy is enabled ```ruby describe azure_monitor_log_profiles.where{ properties.dig(:retentionPolicy, :enabled) == true } do it { should exist } its('count') { should be 4 } end -``` +``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby describe azure_monitor_log_profiles do it { should exist } @@ -92,4 +102,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_database.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_database.md index f8b8231d48..baa287f08e 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_database.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_database.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_mysql_database Resource" parent = "inspec/resources/azure" +++ -Use the `azure_mysql_database` InSpec audit resource to test properties and configuration of an Azure MySQL Database on a MySQL Server. +Use the `azure_mysql_database` InSpec audit resource to test the properties and configuration of an Azure MySQL Database on a MySQL Server. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group`, `server_name` and `name` or the `resource_id` must be given as a parameter. +`resource_group`, `server_name` and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_mysql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do +describe azure_mysql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'NAME') do it { should exist } end ``` + ```ruby describe azure_mysql_database(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases/{databaseName}') do it { should exist } @@ -37,21 +39,22 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `server_name` -: The name of the server on which the database resides. `serverName`. +: The name of the server on which the database resides. `name` -: The unique name of the database. `databaseName`. +: The unique name of the database. `database_name` : Alias for the `name` parameter. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases/{databaseName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group`, `server_name`, and `name` - `resource_group`, `server_name`, and `database_name` @@ -61,20 +64,21 @@ Either one of the parameter sets can be provided for a valid query: `properties.charset` : The charset of the database. -For properties applicable to all resources, such as `type`, `tags`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `tags`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/mysql/databases/get#database) for other properties available. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/mysql/flexibleserver/databases/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test the Name of a Resource.** +### Test the resource name ```ruby -describe azure_mysql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do +describe azure_mysql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'NAME') do its('name') { should be 'order-db' } end ``` + ```ruby describe azure_mysql_database(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases/order-db') do its('name') { should be 'order-db' } @@ -88,19 +92,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect the resource to always exist +# If we expect the resource to always exist. -describe azure_mysql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do +describe azure_mysql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'NAME') do it { should exist } end +``` + +### not_exists -# If we expect the resource to never exist +```ruby +# If we expect the resource to never exist. -describe azure_mysql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do +describe azure_mysql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_databases.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_databases.md index b6860119fc..65f4d9c3eb 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_databases.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_databases.md @@ -10,21 +10,22 @@ identifier = "inspec/resources/azure/azure_mysql_databases Resource" parent = "inspec/resources/azure" +++ -Use the `azure_mysql_databases` InSpec audit resource to test properties and configuration of Azure MySQL Databases. +Use the `azure_mysql_databases` InSpec audit resource to test the properties and configuration of Azure MySQL Databases. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -The `resource_group`, and `server_name` must be given as a parameter. +The `resource_group` and `server_name` are required parameters. + ```ruby -describe azure_mysql_databases(resource_group: 'my-rg', server_name: 'my-server') do +describe azure_mysql_databases(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do it { should exist } end ``` @@ -32,15 +33,15 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `server_name` -: The name of the server in which the database resides. `serverName`. +: The name of the server in which the database resides. ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -64,47 +65,59 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check Resources are Present.** +### Check resources are present -````ruby -describe azure_mysql_databases(resource_group: 'my-rg', server_name: 'my-server') do +```ruby +describe azure_mysql_databases(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do it { should exist } its('names') { should include 'my-db' } end -```` -**Filter the Results to Include Only those with Names Match the Given String Value.** +``` + +### Filter the results to include only those with names match the specified string value ```ruby -describe azure_mysql_databases.(resource_group: 'my-rg', server_name: 'my-server').where{ name.eql?('production-db') } do +describe azure_mysql_databases.(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME').where{ name.eql?('production-db') } do it { should exist } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby -# If we expect resources to exist +# If we expect resources to exist. -describe azure_mysql_databases(resource_group: 'ExampleGroup', server_name: 'my-server') do +describe azure_mysql_databases(resource_group: 'EXAMPLEGROUP', server_name: 'SERVER_NAME') do it { should exist } end +``` -# If we expect resources not to exist +### not_exists + +```ruby +# If we expect resources not to exist. -describe azure_mysql_databases(resource_group: 'ExampleGroup', server_name: 'my-server') do +describe azure_mysql_databases(resource_group: 'EXAMPLEGROUP', server_name: 'SERVER_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_server.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_server.md index 6342d1ae7c..f43b747858 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_server.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_server.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_mysql_server Resource" parent = "inspec/resources/azure" +++ -Use the `azure_mysql_server` InSpec audit resource to test properties and configuration of an Azure MySQL Server. +Use the `azure_mysql_server` InSpec audit resource to test the properties and configuration of an Azure MySQL server. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `name` or the `resource_id` must be given as a parameter. +`resource_group` and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_mysql_server(resource_group: 'inspec-resource-group-9', name: 'example_server') do +describe azure_mysql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do it { should exist } end ``` + ```ruby describe azure_mysql_server(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.DBforMySQL/servers/{serverName}') do it { should exist } @@ -37,21 +39,22 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: Name of the MySql server to test. `MyServer`. +: Name of the MySql server to test. `server_name` -: Name of the MySql server to test. `MyServer`. This is for backward compatibility, use `name` instead. +: Name of the MySql server to test. This is for backward compatibility. Use `name` instead. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.DBforMySQL/servers/{serverName}`. +: The unique resource ID. `firewall_rules_api_version` -: The endpoint api version for the `firewall_rules` property. The latest version will be used unless provided. +: The endpoint API version for the `firewall_rules` property. The latest version will be used unless provided. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` - `resource_group` and `server_name` @@ -64,35 +67,39 @@ Either one of the parameter sets can be provided for a valid query: `sku` : The SKU (pricing tier) of the server. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/mysql/singleserver/servers(2017-12-01)/get) for other properties available. -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/mysql/servers/get#server) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test If a MySQL Server is Referenced with a Valid Name.** +### Test if a MySQL server is referenced with a valid name ```ruby -describe azure_mysql_server(resource_group: 'my-rg', name: 'sql-server-1') do +describe azure_mysql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do it { should exist } end ``` -**Test If a MySQL Server is Referenced with an Invalid Name.** + +### Test if a MySQL server is referenced with an invalid name ```ruby -describe azure_mysql_server(resource_group: 'my-rg', name: 'i-dont-exist') do +describe azure_mysql_server(resource_group: 'RESOURCE_GROUP', name: 'i-dont-exist') do it { should_not exist } end -``` -**Test If a MySQL Server Has Firewall Rules Set.** +``` + +### Test if a MySQL server has firewall rules set ```ruby -describe azure_mysql_server(resource_group: 'my-rg', name: 'my-server') do +describe azure_mysql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do its('firewall_rules') { should_not be_empty } end -``` -**Test a MySQL Server's Fully Qualified Domain Name, Location and Public Network Access Status.** +``` + +### Test a MySQL server's fully qualified domain name, location, and public network access status ```ruby describe azure_mysql_server(resource_id: '/subscriptions/.../my-server') do @@ -109,11 +116,11 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -describe azure_mysql_server(resource_group: 'my-rg', server_name: 'server-name-1') do +describe azure_mysql_server(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME-1') do it { should exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_server_configuration.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_server_configuration.md new file mode 100644 index 0000000000..3eae9eb72c --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_server_configuration.md @@ -0,0 +1,123 @@ ++++ +title = "azure_mysql_database_configuration Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_mysql_database_configuration" +identifier = "inspec/resources/azure/azure_mysql_database_configuration Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_mysql_database_configuration` InSpec audit resource to test the properties of an Azure MySQL Database Configuration on a MySQL Database Server. + +## Syntax + +`resource_group`, `server_name` and `name`, or the `resource_id` are required parameters. + +```ruby +describe azure_mysql_database_configuration(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'CONFIGURATION_NAME') do + it { should exist } +end +``` + +```ruby +describe azure_mysql_database_configuration(resource_id: 'RESOURCE_ID') do + it { should exist } +end +``` + +## Parameters + +`resource_group` +: Azure resource group where the targeted resource resides. + +`server_name` +: The name of the server on which the database resides. + +`name` +: The unique name of the database configuration. + +`resource_id` +: The unique resource ID. + +Either one of the parameter sets can be provided for a valid query: + +- `resource_id` +- `resource_group`, `server_name`, and `name` + +## Properties + +`id` +: The id of the resource. + +`name` +: The name of the resource. + +`type` +: The type of the resource. + +`properties.allowedValues` +: Allowed values of the configuration. + +`properties.dataType` +: Data type of the configuration. + +`properties.defaultValue` +: Default value of the configuration. + +`properties.description` +: Description of the configuration. + +`properties.source` +: Source of the configuration. + +`properties.value` +: Value of the configuration. + + +For properties applicable to all resources, such as `type`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://learn.microsoft.com/en-us/rest/api/mysql/singleserver/configurations/get?tabs=HTTP) for other properties available. +Any attribute in the response may be accessed with the key names separated by dots (`.`). + +## Examples + +### Test the resource name + +```ruby +describe azure_mysql_database_configuration(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'CONFIGURATION_NAME') do + its('name') { should be 'CONFIGURATION_NAME' } +end +``` + +```ruby +describe azure_mysql_database_configuration(resource_id: 'RESOURCE_ID') do + its('name') { should be 'CONFIGURATION_NAME' } +end +``` + +## Matchers + +This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://docs.chef.io/inspec/matchers/). + +### exists + +```ruby +# If we expect the resource to always exist. +describe azure_mysql_database_configuration(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'CONFIGURATION_NAME') do + it { should exist } +end +``` + +```ruby +# If we expect the resource to never exist. +describe azure_mysql_database_configuration(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'CONFIGURATION_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_server_configurations.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_server_configurations.md new file mode 100644 index 0000000000..905828a41c --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_server_configurations.md @@ -0,0 +1,116 @@ ++++ +title = "azure_mysql_database_configurations Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_mysql_database_configurations" +identifier = "inspec/resources/azure/azure_mysql_database_configurations Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_mysql_database_configurations` InSpec audit resource to test the properties of an Azure MySQL Database Configuration on a MySQL Database Server. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +The `resource_group` and `server_name` are required parameters. + +```ruby +describe azure_mysql_database_configuration(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + it { should exist } +end +``` + +## Parameters + +`resource_group` +: Azure resource group where the targeted resource resides. + +`server_name` +: The name of the server in which the database resides. + +## Properties + +`ids` +: A list of the unique resource IDs. + +: **Field**: `id` + +`names` +: A list of names of all the resources being interrogated. + +: **Field**: `name` + +`types` +: A list of the types of resources being interrogated. + +: **Field**: `type` + +`properties` +: A list of properties for all the resources being interrogated. + +: **Field**: `properties` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Check resources are present + +```ruby +describe azure_mysql_database_configuration(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + it { should exist } + its('names') { should include 'my-db' } +end +``` + +### Filter the results to include only those with names match the specified string value + +```ruby +describe azure_mysql_database_configuration(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME').where{ name.eql?('user-override') } do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + +```ruby +# If we expect resources to exist. + +describe azure_mysql_database_configuration(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + it { should exist } +end +``` + +```ruby +# If we expect resources not to exist. + +describe azure_mysql_database_configuration(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_servers.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_servers.md index fad0a1a9bc..12972b7c84 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_servers.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_mysql_servers.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_mysql_servers Resource" parent = "inspec/resources/azure" +++ -Use the `azure_mysql_servers` InSpec audit resource to test properties and configuration of multiple Azure MySQL Servers. +Use the `azure_mysql_servers` InSpec audit resource to test the properties and configuration of multiple Azure MySQL servers. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_mysql_servers` resource block returns all Azure MySQL Servers, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_mysql_servers` resource block returns all Azure MySQL servers within a resource group (if provided) or an entire subscription. + ```ruby describe azure_mysql_servers do #... end ``` -or + +Or + ```ruby -describe azure_mysql_servers(resource_group: 'my-rg') do +describe azure_mysql_servers(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -73,11 +76,15 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check MySQL Servers are present.** +### Check MySQL servers are present ```ruby describe azure_mysql_servers do @@ -85,35 +92,41 @@ describe azure_mysql_servers do its('names') { should include 'my-server-name' } end ``` -**Filters the Results to Include Only Those Servers which Include the Given Name (Client Side Filtering).** + +### Filters the results to include only those servers that have the specified name (Client Side Filtering) ```ruby describe azure_mysql_servers.where{ name.include?('production') } do it { should exist } end ``` -**Filters the Results to Include Only Those Servers which Reside in a Given Location (Client Side Filtering).** + +### Filters the results to include only those servers which reside in a specified location (Client Side Filtering) ```ruby describe azure_mysql_servers.where{ location.eql?('westeurope') } do it { should exist } end -``` -**Filters the Results to Include Only Those Servers which Reside in a Given Location and Include the Given Name (Server Side Filtering - Recommended).** +``` + +### Filters the results to include only those servers which reside in a specified location and have the specified name (Server Side Filtering - Recommended) ```ruby describe azure_generic_resources(resource_provider: 'Microsoft.DBforMySQL/servers', substring_of_name: 'production', location: 'westeurope') do - it {should exist} + it {should exist} end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby describe azure_mysql_servers do it { should exist } @@ -122,4 +135,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_interface.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_interface.md index 465799a819..ff9254296b 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_interface.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_interface.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_network_interface Resource" parent = "inspec/resources/azure" +++ -Use the `azure_network_interface` InSpec audit resource to test properties and configuration of Azure Network Interface. +Use the `azure_network_interface` InSpec audit resource to test the properties and configuration of the Azure Network interface. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_network_interface` resource block identifies an AKS Cluster by `name` and `resource_group` or the `resource_id`. +An `azure_network_interface` resource block identifies an AKS Cluster by `name` and `resource_group`, or the `resource_id`. + ```ruby -describe azure_network_interface(resource_group: 'example', name: 'networkInterfaceName') do +describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORKINTERFACENAME') do it { should exist } end ``` + ```ruby describe azure_network_interface(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}') do it { should exist } @@ -37,15 +39,16 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: Name of the AKS cluster to test. `networkInterfaceName`. +: Name of the AKS cluster to test. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` @@ -75,24 +78,26 @@ Either one of the parameter sets can be provided for a valid query: `has_public_address_ip?` : Indicates whether the interrogated network interface has a public IP address. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/networkinterfaces/get#networkinterface) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. + +Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test if IP Forwarding is Enabled.** +### Test if IP forwarding is enabled ```ruby -describe azure_network_interface(resource_group: 'my-rg', name: 'networkInterfaceName') do +describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_INTERFACE_NAME') do its('properties.enableIPForwarding') { should be_true } end ``` -**Test if the Primary IP Configuration is Set to Correct Private IP Address.** + +### Test if the primary IP configuration is set to correct private IP address ```ruby -describe azure_network_interface(resource_group: 'my-rg', name: 'networkInterfaceName') do +describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_INTERFACE_NAME') do its('private_ip') { should cmp '172.16.2.6' } end ``` @@ -103,9 +108,10 @@ This InSpec audit resource has the following special matchers. For a full list o ### be_primary -Tests if a network interface is the primary network interface on a Virtual Machine. +Tests if a network interface is the primary network interface on a virtual machine. + ```ruby -describe azure_network_interface(resource_group: 'my-rg', name: 'networkInterfaceName') do +describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_INTERFACE_NAME') do it {should be_primary} end ``` @@ -113,8 +119,9 @@ end ### have_public_address_ip Test if a network interface has a public IP address. + ```ruby -describe azure_network_interface(resource_group: 'my-rg', name: 'networkInterfaceName') do +describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_INTERFACE_NAME') do it { should have_public_address_ip} end ``` @@ -122,25 +129,33 @@ end ### have_private_address_ip Test if a network interface has a private IP address. + ```ruby -describe azure_network_interface(resource_group: 'my-rg', name: 'networkInterfaceName') do +describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_INTERFACE_NAME') do it { should have_private_address_ip} end ``` + ### exists ```ruby -# If we expect 'networkInterfaceName' to always exist -describe azure_network_interface(resource_group: 'my-rg', name: 'networkInterfaceName') do +# If we expect 'NETWORK_INTERFACE_NAME' to always exist. + +describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_INTERFACE_NAME') do it { should exist } end +``` + +### not_exists + +```ruby +# If we expect 'NETWORK_INTERFACE_NAME' to never exist. -# If we expect 'networkInterfaceName' to never exist -describe azure_network_interface(resource_group: 'my-rg', name: 'networkInterfaceName') do +describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_INTERFACE_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_interfaces.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_interfaces.md index d7f2e4ceee..e734cf5ba3 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_interfaces.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_interfaces.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_network_interfaces Resource" parent = "inspec/resources/azure" +++ -Use the `azure_network_interfaces` InSpec audit resource to test properties and configuration of Azure Network Interfaces. +Use the `azure_network_interfaces` InSpec audit resource to test the properties and configuration of Azure Network interfaces. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_network_interfaces` resource block returns all Azure Network Interfaces, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_network_interfaces` resource block returns all Azure Network interfaces within a resource group (if provided) or an entire subscription. + ```ruby describe azure_network_interfaces do #... end ``` -or + +Or + ```ruby -describe azure_network_interfaces(resource_group: 'my-rg') do +describe azure_network_interfaces(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -73,11 +76,15 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check Network Interfaces are Present.** +### Check network interfaces are present ```ruby describe azure_network_interfaces do @@ -85,7 +92,8 @@ describe azure_network_interfaces do its('names') { should include 'my-network-interface' } end ``` -**Filter the Results to Include Only those with Names Match the Given String Value.** + +### Filter the results to include only those with names that match the specified string value ```ruby describe azure_network_interfaces.where{ name.include?('my-network') } do @@ -95,24 +103,32 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby -# If we expect 'ExampleGroup' Resource Group to have Network Interfaces -describe azure_network_interfaces(resource_group: 'ExampleGroup') do +# If we expect 'EXAMPLEGROUP' resource group to have network interfaces. + +describe azure_network_interfaces(resource_group: 'EXAMPLEGROUP') do it { should exist } end +``` + +### not_exists -# If we expect 'EmptyExampleGroup' Resource Group to not have Network Interfaces -describe azure_network_interfaces(resource_group: 'EmptyExampleGroup') do +```ruby +# If we expect 'EMPTYEXAMPLEGROUP' resource group to not have network interfaces. + +describe azure_network_interfaces(resource_group: 'EMPTYEXAMPLEGROUP') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} - +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_security_group.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_security_group.md index cba664b0b3..3869429ac8 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_security_group.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_security_group.md @@ -10,22 +10,22 @@ identifier = "inspec/resources/azure/azure_network_security_group Resource" parent = "inspec/resources/azure" +++ -Use the `azure_network_security_group` InSpec audit resource to test properties of an Azure Network Security Group. +Use the `azure_network_security_group` InSpec audit resource to test the properties of an Azure Network Security group. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_network_security_group` resource block identifies a Network Security Group by `name` and `resource_group` or the `resource_id`. +An `azure_network_security_group` resource block identifies a Network Security group by `name` and `resource_group`, or the `resource_id`. ```ruby -describe azure_network_security_group(resource_group: 'example', name: 'GroupName') do +describe azure_network_security_group(resource_group: 'RESOURCE_GROUP', name: 'GROUP_NAME') do it { should exist } end ``` @@ -39,16 +39,16 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in.`MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: Name of the Azure resource to test. `MyNSG`. +: Name of the Azure resource to test. `resource_id` : The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/networkSecurityGroups/{nsgName}`. `resource_data` -: In-memory cached Azure Network security group data. Passing data to this parameter can increase performance since it avoids multiple network calls to the same Azure resource. When provided, it binds the values directly to the resource. Data passed to the `resource_data` parameter could be stale. It is the user's responsibility to refresh the data. +: In-memory cached Azure Network Security group data. Passing data to this parameter can increase performance since it avoids multiple network calls to the same Azure resource. When provided, it binds the values directly to the resource. Data passed to the `resource_data` parameter could be stale. It is the user's responsibility to refresh the data. Provide one of the following parameter sets for a valid query: @@ -91,76 +91,76 @@ Provide one of the following parameter sets for a valid query: `allowed_out?**` : Alias for `allow_out?`. `it { should_not be_allowed_out(service_tag: 'Internet') }`. -* These properties do not take the priorities of security rules into account. -For example, if there are two security rules and one of them is allowing SSH from internet while the other one is prohibiting, `allow_ssh_from_internet` will pass without comparing the priority of the conflicting security rules. -Therefore, it is recommended to use `allow`, `allow_in` or `allow_out` properties with which the priorities are taken into consideration. +* These properties do not take the priorities of security rules into account. For example, if suppose there are two security rules. In that case, one of them is allowing SSH from the internet while the other is prohibiting, `allow_ssh_from_internet` will pass without comparing the priority of the conflicting security rules. Therefore, it is recommended to use `allow`, `allow_in`, or `allow_out` properties with which the priorities are considered. -** These properties do not compare criteria defined by explicit ip ranges with the security rules defined by [Azure service tags](https://docs.microsoft.com/en-us/azure/virtual-network/service-tags-overview) and vice versa. -For example, providing that a network security group has a single security rule allowing all traffics from internet by using `Internet` service tag in the source will fail the `allow_in(ip_range: '64.233.160.0')` test due to incompatible source definitions. -This is because InSpec Azure resource pack has no control over which ip ranges are defined in Azure service tags. -Therefore, tests using these methods should be written explicitly for service tags and ip ranges. -For more information about network security groups and security rules refer to [here](https://docs.microsoft.com/en-us/azure/virtual-network/security-overview). -`*ip_range` used in these methods support IPv4 and IPv6. The ip range criteriaom should be written in CIDR notation. +** These properties do not compare criteria defined by explicit IP ranges with the security rules defined by [Azure service tags](https://docs.microsoft.com/en-us/azure/virtual-network/service-tags-overview) and vice versa. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For example, providing that a network security group has a single security rule allowing all traffic from the internet by using `Internet` service tag in the source will fail the `allow_in(ip_range: '64.233.160.0')` test due to incompatible source definitions. This is because the InSpec Azure resource pack has no control over which IP ranges are defined in Azure service tags. Therefore, tests using these methods should be written explicitly for service tags and IP ranges. For more information about network security groups and security rules, refer to [here](https://docs.microsoft.com/en-us/azure/virtual-network/security-overview). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/networksecuritygroups/get#networksecuritygroup) for other properties available. -Any property in the response may be accessed with the key names separated by dots (`.`). +`*ip_range` used in these methods supports IPv4 and IPv6. The IP range criteria should be written in CIDR notation. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/networksecuritygroups/get#networksecuritygroup) for other properties available. Any property in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test that a Resource Group Has the Specified Network Security Group.** +### Test that a resource group has the specified Network Security group ```ruby -describe azure_network_security_group(resource_group: 'example', name: 'GroupName') do +describe azure_network_security_group(resource_group: 'RESOURCE_GROUP', name: 'GROUP_NAME') do it { should exist } end ``` -**Test that a Network Security Group Allows SSH from the Internet.** + +### Test that a Network Security group allows SSH from the internet ```ruby -describe azure_network_security_group(resource_group: 'example', name: 'GroupName') do +describe azure_network_security_group(resource_group: 'RESOURCE_GROUP', name: 'GROUP_NAME') do it { should allow_ssh_from_internet } end ``` -**Test that a Network Security Group Allows Inbound Traffics from a Certain Ip Range in Any Port and Any Protocol.** + +### Test that a Network Security group allows inbound traffics from a certain IP range in any port and protocol ```ruby -describe azure_network_security_group(resource_group: 'example', name: 'GroupName') do +describe azure_network_security_group(resource_group: 'RESOURCE_GROUP', name: 'GROUP_NAME') do it { should allow(source_ip_range: '10.0.0.0/24', direction: 'inbound') } **same test with the specific inbound rule check.** - end ``` -**Test that a Network Security Group Allows Inbound Traffics from Internet Service Tag in Port `80` and `TCP` Protocol.** + +### Test that a Network Security group allows inbound traffics from internet service tag in port `80` and `TCP` protocol ```ruby -describe azure_network_security_group(resource_group: 'example', name: 'GroupName') do +describe azure_network_security_group(resource_group: 'RESOURCE_GROUP', name: 'GROUP_NAME') do it { should allow(source_service_tag: 'Internet', destination_port: '22', protocol: 'TCP', direction: 'inbound') } **same test with the specific inbound rule check.** end ``` -**Test that a Network Security Group Allows Inbound Traffics from Virtual Network Service Tag in a Range of Ports and Any Protocol.** + +### Test that a Network Security group allows inbound traffics from virtual network service tag in a port range and protocol ```ruby -describe azure_network_security_group(resource_group: 'example', name: 'GroupName') do +describe azure_network_security_group(resource_group: 'RESOURCE_GROUP', name: 'GROUP_NAME') do it { should allow(source_service_tag: 'VirtualNetwork', destination_port: %w{22 8080 56-78}, direction: 'inbound') } **same test with the specific inbound rule check.** end ``` -**Test that a Network Security Group Allows Outbound Traffics to a Certain Ip Range in any Port and Any Protocol.** + +### Test that a Network Security group allows outbound traffics to a certain IP range in any port and protocol ```ruby -describe azure_network_security_group(resource_group: 'example', name: 'GroupName') do +describe azure_network_security_group(resource_group: 'RESOURCE_GROUP', name: 'GROUP_NAME') do it { should allow(destination_ip_range: '10.0.0.0/24', direction: 'outbound') } **same test with the specific outbound rule check.** end ``` -**Loop through multiple network security groups and verify that each group does not allow inbound traffic from already cached data.** +### Loop through multiple Network Security groups and verify that each group does not allow inbound traffic from already cached data ```ruby azure_network_security_groups.entries.each do |azure_network_security_group_data| @@ -172,29 +172,53 @@ azure_network_security_groups.entries.each do |azure_network_security_group_data end ``` -Please note that `allow` requires the `direction` parameter be set to either `inbound` or `outbound` -and you must prefix the `ip_range`, `service_tag`, and `port` with either `source_` or `destination_` identifiers. +{{< note >}} + +Please note that `allow` requires the `direction` parameter to be set to `inbound` or `outbound` and you must prefix the `ip_range`, `service_tag`, and `port` with `source_` or `destination_` identifiers. + +{{< /note >}} ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the resource returns a result. Use `should_not` if you expect zero matches. +The control passes if the resource returns a result. Use `should_not` if you expect zero matches. + ```ruby -# If we expect 'GroupName' to always e``xrubyst -describe azure_network_security_group(resource_group: 'example', name: 'GroupName') do +# If we expect 'GROUPNAME' to always exist. + +describe azure_network_security_group(resource_group: 'RESOURCE_GROUP', name: 'GROUP_NAME') do it { should exist } end +``` + +### not_exists + +```ruby +# If we expect 'EMPTYGROUPNAME' to never exist. -# If we expect 'EmptyGroupName' to never e``xrubyst -describe azure_network_security_group(resource_group: 'example', name: 'EmptyGroupName') do +describe azure_network_security_group(resource_group: 'RESOURCE_GROUP', name: 'GROUP_NAME') do it { should_not exist } end ``` +### Test that a Network Security group should not allow UDP from the internet -## Azure Permissions +```ruby +describe azure_network_security_group(resource_group: 'RESOURCE_GROUP', name: 'GROUP_NAME') do + it { should_not allow_udp_from_internet } +end +``` +### Validating Number of days to retain flow log records. -{{% azure_permissions_service_principal role="reader" %}} +```ruby +describe azure_network_security_group(resource_group: 'RESOURCE_GROUP', name: 'GROUP_NAME') do + its('flow_log_retention_period') { should eq 0 } +end +``` +## Azure Permissions +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_security_groups.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_security_groups.md index a053952087..63752c6367 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_security_groups.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_security_groups.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_network_security_groups Resource" parent = "inspec/resources/azure" +++ -Use the `azure_network_security_groups` InSpec audit resource to enumerate Network Security Groups. +Use the `azure_network_security_groups` InSpec audit resource to enumerate the Network Security groups. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_network_security_groups` resource block returns all Azure network security groups, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_network_security_groups` resource block returns all Azure network security groups within a resource group or an entire subscription. + ```ruby describe azure_network_security_groups do #... end ``` -or + +Or + ```ruby -describe azure_network_security_groups(resource_group: 'my-rg') do +describe azure_network_security_groups(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -72,19 +75,23 @@ end : A list of all properties of all the resources. : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test that an Example Resource Group Has the Named Network Security Group.** +### Test that an example resource group has the named network security group ```ruby -describe azure_network_security_groups(resource_group: 'ExampleGroup') do +describe azure_network_security_groups(resource_group: 'EXAMPLEGROUP') do its('names') { should include('ExampleNetworkSecurityGroup') } end ``` -**Filters the Network Security Groups at Azure API to Only Those that Match the Given Name via Generic Resource (Recommended).** +### Filters the Network Security groups at Azure API to only those that match the specified name via a generic resource (Recommended) ```ruby **Fuzzy string matching.** @@ -102,23 +109,32 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the resource returns a result. Use `should_not` if you expect zero matches. +The control passes if the resource returns a result. Use `should_not` if you expect zero matches. + ```ruby -# If we expect 'ExampleGroup' Resource Group to have Network Security Groups -describe azure_network_security_groups(resource_group: 'ExampleGroup') do +# If we expect the 'EXAMPLEGROUP' resource group to have Network Security groups. + +describe azure_network_security_groups(resource_group: 'EXAMPLEGROUP') do it { should exist } end +``` + +### not_exists + +```ruby +# If we expect the 'EmptyExampleGroup' resource group to not have Network Security groups. -# If we expect 'EmptyExampleGroup' Resource Group to not have Network Security Groups -describe azure_network_security_groups(resource_group: 'EmptyExampleGroup') do +describe azure_network_security_groups(resource_group: 'EMPTYEXAMPLEGROUP') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="reader" %}} +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_watcher.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_watcher.md index 522dcc65b6..9c551eeb82 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_watcher.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_watcher.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_network_watcher Resource" parent = "inspec/resources/azure" +++ -Use the `azure_network_watcher` InSpec audit resource to test properties of an Azure network watcher. +Use the `azure_network_watcher` InSpec audit resource to test the properties of an Azure Network Watcher. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_network_watcher` resource block identifies a network watcher by `name` and `resource_group` or the `resource_id`. +An `azure_network_watcher` resource block identifies a Network Watcher by `name` and `resource_group`, or the `resource_id`. + ```ruby -describe azure_network_watcher(resource_group: 'resourceGroupName', name: 'networkWatcherName') do +describe azure_network_watcher(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_WATCHER_NAME') do it { should exist } end ``` + ```ruby describe azure_network_watcher(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}') do it { should exist } @@ -37,16 +39,16 @@ end ## Parameters `resource_group` -: Azure resource group that the network watcher resides in. `resourceGroupName`. +: Azure resource group where the network watcher resides. `name` -: Name of the network watcher to test. `networkWatcherName`. +: Name of the network watcher to test. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}`. +: The unique resource ID. `flow_logs_api_version` -: The flow log status endpoint api version used for creating `flow_logs` property. The latest version will be used unless provided. A network security group within the same region can be targeted for getting the flow log statuses. For more, see [here](https://docs.microsoft.com/en-us/rest/api/network-watcher/networkwatchers/getflowlogstatus). +: The flow log status endpoint API version used for creating `flow_logs` property. The latest version will be used unless provided. A network security group within the same region can be targeted for getting the flow log statuses. For more, see [here](https://docs.microsoft.com/en-us/rest/api/network-watcher/networkwatchers/getflowlogstatus). `nsg_resource_id` : The unique resource ID of the network security group being targeted to get the flow log statuses. `/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}`. @@ -57,8 +59,8 @@ end `nsg_name` : The name of the network security group being targeted to get the flow log statuses. This requires `nsg_resource_group` to be provided. - Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` @@ -68,41 +70,43 @@ Either one of the parameter sets can be provided for a valid query: : The provisioning state of the network watcher resource. For the valid values, see [here](https://docs.microsoft.com/en-us/rest/api/network-watcher/networkwatchers/get#provisioningstate). `flow_logs` -: Information on the configuration of flow log and traffic analytics (optional) in [this format](https://docs.microsoft.com/en-us/rest/api/network-watcher/networkwatchers/getflowlogstatus#flowloginformation). All properties can be accessed via dot notation, e.g.: `flow_logs.properties.enabled`. This resource supports targeting network security groups defined at resource creation only. +: Information on the configuration of flow log and traffic analytics (optional) in [this format](https://docs.microsoft.com/en-us/rest/api/network-watcher/networkwatchers/getflowlogstatus#flowloginformation). All properties can be accessed via dot notation. For example, `flow_logs.properties.enabled`. This resource supports targeting network security groups defined at resource creation only. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/network-watcher/networkwatchers/get#networkwatcher) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/network-watcher/networkwatchers/get#networkwatcher) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test the Location of a Network Watcher.** +### Test the location of a Network Watcher ```ruby -describe azure_network_watcher(resource_group: 'resourceGroupName', name: 'networkWatcherName') do +describe azure_network_watcher(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_WATCHER_NAME') do its('location') { should cmp 'eastus' } end ``` -**Test the Flow Log Status of a Network Security Group.** + +### Test the Flow Log status of a Network Security group ```ruby -describe azure_network_watcher(resource_group: 'resourceGroupName', name: 'networkWatcherName', nsg_resource_group: 'nsg_rg', nsg_name: 'nsg_eastus') do +describe azure_network_watcher(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_WATCHER_NAME', nsg_resource_group: 'NSG_RESOURCE_GROUP', nsg_name: 'nsg_eastus') do its('flow_logs.properties.enabled') { should be true } its('flow_logs.properties.retentionPolicy.days') { should be >= 90 } end ``` -**Loop through Network Security Groups with the Resource ID.** + +### Loop through Network Security groups with the resource ID ```ruby azure_network_security_groups.where(location: 'eastus').ids.each do |nsg_id| - describe azure_network_watcher(resource_group: 'resourceGroupName', name: 'networkWatcherName', nsg_resource_id: nsg_id) do + describe azure_network_watcher(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_WATCHER_NAME', nsg_resource_id: nsg_id) do its('flow_logs.properties.enabled') { should be true } its('flow_logs.properties.retentionPolicy.days') { should be >= 90 } end end ``` -See [integration tests](../../test/integration/verify/controls/azurerm_network_watcher.rb) for more examples. + +See [integration tests](https://github.com/inspec/inspec-azure/blob/main/test/integration/verify/controls/azure_network_watcher.rb) for more examples. ## Matchers @@ -111,17 +115,19 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect 'networkWatcherName' to always exist -describe azure_network_watcher(resource_group: 'resourceGroupName', name: 'networkWatcherName') do +# If we expect 'NETWORKWATCHERNAME' to always exist. + +describe azure_network_watcher(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_WATCHER_NAME') do it { should exist } end -# If we expect 'networkWatcherName' to never exist -describe azure_network_watcher(resource_group: 'resourceGroupName', name: 'networkWatcherName') do +# If we expect 'NETWORKWATCHERNAME' to never exist. + +describe azure_network_watcher(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_WATCHER_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_watchers.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_watchers.md index c048a2e47e..121eb7bbb3 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_watchers.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_network_watchers.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_network_watchers Resource" parent = "inspec/resources/azure" +++ -Use the `azure_network_watchers` InSpec audit resource to test properties and configuration of multiple Azure network watchers. +Use the `azure_network_watchers` InSpec audit resource to test the properties and configuration of multiple Azure Network Watchers. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_network_watchers` resource block returns all network watchers, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_network_watchers` resource block returns all network watchers within a resource group (if provided) or an entire subscription. ```ruby describe azure_network_watchers do @@ -33,7 +33,7 @@ end or ```ruby -describe azure_network_watchers(resource_group: 'my-rg') do +describe azure_network_watchers(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -47,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -66,38 +66,50 @@ end : **Field**: `tags` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test that an Example Resource Group has the Named Network Watcher.** +### Test that an example resource group has the named Network Watcher ```ruby -describe azure_network_watchers(resource_group: 'ExampleGroup') do +describe azure_network_watchers(resource_group: 'EXAMPLEGROUP') do its('names') { should include('NetworkWatcherName') } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. ```ruby -# If we expect 'ExampleGroup' Resource Group to have Network Watchers +# If we expect 'EXAMPLEGROUP' resource group to have Network Watchers. + describe azure_network_watchers(resource_group: 'ExampleGroup') do it { should exist } end +``` + +### not_exists + +```ruby +# If we expect 'EMPTYEXAMPLEGROUP' resource group to not have Network Watchers. -# If we expect 'EmptyExampleGroup' Resource Group to not have Network Watchers -describe azure_network_watchers(resource_group: 'EmptyExampleGroup') do +describe azure_network_watchers(resource_group: 'EMPTYEXAMPLEGROUP') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_assignments.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_assignments.md index 933bc5393b..e729666fb9 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_assignments.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_assignments.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_policy_assignments Resource" parent = "inspec/resources/azure" +++ -Use the `azure_policy_assignments` InSpec resource to examine assignments of Azure policy to resources and resource groups. +Use the `azure_policy_assignments` InSpec resource to examine assignments of the Azure policy to resources and resource groups. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -138,7 +138,7 @@ Please review the [Azure documentation](https://docs.microsoft.com/en-us/rest/ap ## Examples -**Check that all assigned policies are in enforcing mode.** +### Check that all assigned policies are in enforcing mode ```ruby describe azure_policy_assignments.where{ enforcement_mode == 'DoNotEnforce' } do @@ -147,7 +147,7 @@ describe azure_policy_assignments.where{ enforcement_mode == 'DoNotEnforce' } do end ``` -**Check that no policies were modified in the last 30 days.** +### Check that no policies were modified in the last 30 days ```ruby last_30_days = Time.now() - (60*60*24*30) @@ -160,4 +160,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_definition.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_definition.md index 6554620f14..431c5b9e15 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_definition.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_definition.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_policy_definition Resource" parent = "inspec/resources/azure" +++ -Use the `azure_policy_definition` InSpec audit resource to test properties and configuration of an Azure policy definition. +Use the `azure_policy_definition` InSpec audit resource to test the properties and configuration of an Azure Policy definition. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`name` or the `resource_id` must be given as a parameter. +`name` or the `resource_id` are required parameters. + ```ruby -describe azure_policy_definition(name: 'my_policy') do +describe azure_policy_definition(name: 'MY_POLICY') do it { should exist } end ``` + ```ruby describe azure_policy_definition(resource_id: '/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}') do it { should exist } @@ -39,13 +41,14 @@ end `name` : Name of the policy definition. `policyDefinitionName`. -`built_in` -: Indicates whether the policy definition is built-in. Optional. Defaults to `false` if not supplied. This should not be used when `resource_id` is provided. +`built_in` _Optional_ +: Indicates whether the policy definition is built-in. Defaults to `false` if not supplied. This should not be used when `resource_id` is provided. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `name` - `name` and `built_in` @@ -64,56 +67,64 @@ Either one of the parameter sets can be provided for a valid query: `properties.policyRule` : The policy rule. +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). - -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/resources/policydefinitions/get#policydefinition) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/policy/policy-definitions/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test a Policy Definition Display Name.** +### Test a policy definition display name ```ruby -describe azure_policy_definition(name: 'my_policy') do +describe azure_policy_definition(name: 'MY_POLICY') do its('properties.displayName') { should cmp "Enforce 'owner' tag on resource groups" } end ``` -**Test a Policy Definition Rule.** + +### Test a policy definition rule ```ruby -describe azure_policy_definition(name: 'my_policy', built_in: true ) do +describe azure_policy_definition(name: 'MY_POLICY', built_in: true ) do its('properties.policyRule.then.effect') { should cmp 'deny' } end -``` +``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### custom Test if a policy definition type is `Custom` or not. + ```ruby -describe azure_policy_definition(name: 'my_policy') do +describe azure_policy_definition(name: 'MY_POLICY') do it { should be_custom } end ``` + ### exists ```ruby -# If we expect a resource to always exist +# If we expect a resource to always exist. -describe azure_policy_definition(name: 'my_policy', built_in: true ) do +describe azure_policy_definition(name: 'MY_POLICY', built_in: true ) do it { should exist } end -# If we expect a resource to never exist +``` + +### not_exists + +```ruby +# If we expect a resource to never exist. -describe azure_policy_definition(name: 'my_policy') do +describe azure_policy_definition(name: 'MY_POLICY') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_definitions.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_definitions.md index c1ae642c7c..542c758f1c 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_definitions.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_definitions.md @@ -10,26 +10,27 @@ identifier = "inspec/resources/azure/azure_policy_definitions Resource" parent = "inspec/resources/azure" +++ -Use the `azure_policy_definitions` InSpec audit resource to test properties and configuration of multiple Azure policy definitions. +Use the `azure_policy_definitions` InSpec audit resource to test the properties and configuration of multiple Azure Policy definitions. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_policy_definitions` resource block returns all policy definitions, either built-in (if `built_in_only: true`), or within a subscription. +An `azure_policy_definitions` resource block returns all policy definitions built-in (if `built_in_only: true`) or within a subscription. + ```ruby describe azure_policy_definitions do it { should exist } end ``` -or +Or ```ruby describe azure_policy_definitions(built_in_only: true) do @@ -46,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -90,40 +91,49 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check a Specific Policy Definition is Present.** +### Check a specific Policy definition is present ```ruby describe azure_policy_definitions do its('names') { should include 'my-policy' } end ``` -**Filters the Results to Include Only Those Policy Definitions which Include the Given Name.** + +### Filters the results to include only those Policy definitions which include the specified name ```ruby describe azure_policy_definitions.where{ name.include?('my-policy') } do it { should exist } end ``` -**Filters the Results to Include Only The Custom Policy Definitions.** + +### Filters the results to include only the custom Policy definitions ```ruby describe azure_policy_definitions.where(policy_type: "Custom") do it { should exist } its('count') { should be 15 } end -``` +``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby describe azure_policy_definitions do it { should exist } @@ -132,4 +142,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_exemption.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_exemption.md index 7fec296c38..96f8d2b547 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_exemption.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_exemption.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_policy_exemption Resource" parent = "inspec/resources/azure" +++ -Use the `azure_policy_exemption` InSpec audit resource to test properties related to a Azure Policy Exemption. +Use the `azure_policy_exemption` InSpec audit resource to test the properties related to an Azure Policy Exemption. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -67,7 +67,7 @@ end : The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. `properties.exemptionCategory` -: The policy exemption category. Possible values are Waiver and Mitigated. +: The policy exemption category. Possible values are `Waiver` and `Mitigated`. `properties.displayName` : The display name of the policy exemption. @@ -78,14 +78,14 @@ end `systemData.createdBy` : The identity that created the resource. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/policy/policy-exemptions/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test that the policy exemption category is `Waiver`.** +### Test that the policy exemption category is `Waiver` ```ruby describe azure_policy_exemption(name: 'POLICY_EXEMPTION_NAME') do @@ -93,7 +93,7 @@ describe azure_policy_exemption(name: 'POLICY_EXEMPTION_NAME') do end ``` -**Test that the definition reference ID list includes a particular reference ID.** +### Test that the definition reference ID list includes a particular reference ID ```ruby describe azure_policy_exemption(resource_group: 'RESOURCE_GROUP', name: 'POLICY_EXEMPTION_NAME') do @@ -108,13 +108,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a policy exemption is found it will exist +# If a policy exemption is found, it will exist. describe azure_policy_exemption(name: 'POLICY_EXEMPTION_NAME') do it { should exist } end +``` + +### not_exists + +```ruby +# policy exemptions that aren't found will not exist. -# policy exemptions that aren't found will not exist describe azure_policy_exemption('3b8b3f3bbec24cd6af583694') do it { should_not exist } end @@ -122,4 +127,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_exemptions.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_exemptions.md index ffbf302645..0a6787ad51 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_exemptions.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_exemptions.md @@ -14,15 +14,16 @@ Use the `azure_policy_exemptions` InSpec audit resource to test properties relat ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_policy_exemptions` resource block returns all Azure Policy Exemptions within a Subscription. +An `azure_policy_exemptions` resource block returns all Azure Policy Exemptions within a subscription. + ```ruby describe azure_policy_exemptions do #... @@ -34,12 +35,12 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` `names` -: A list of names for all the Resources. +: A list of names for all the resources. : **Field**: `name` @@ -49,7 +50,7 @@ end : **Field**: `type` `properties` -: A list of Properties all the resources. +: A list of properties for all the resources. : **Field**: `properties` @@ -64,27 +65,27 @@ end : **Field**: `policy_assignment_id` `policy_definition_reference_ids` -: A list of Policy Definition Reference Ids. +: A list of Policy Definition Reference IDs. : **Field**: `policy_definition_reference_ids` `exemption_categories` -: A list of categories of Exemptions. +: A list of categories of exemptions. : **Field**: `exemption_category` `display_names` -: A list of display names of the Exemptions. +: A list of display names of the exemptions. : **Field**: `display_name` `descriptions` -: A list of descriptions of the Exemptions. . +: A list of descriptions of the exemptions. : **Field**: `description` `metadata` -: A list of metadata info of the Exemptions. +: A list of metadata info of the exemptions. : **Field**: `metadata` @@ -94,7 +95,7 @@ end : **Field**: `created_by` `created_by_types` -: A list of type of creators of the exemptions. +: A list of the type of creators of the exemptions. : **Field**: `created_by_type` @@ -104,56 +105,66 @@ end : **Field**: `created_at` `last_modified_by` -: A list of last modifiers of the exemptions. +: A list of the last modifiers of the exemptions. : **Field**: `last_modified_by` `last_modified_by_types` -: A list of type of the modifiers of the exemptions. +: A list of the type of modifiers of the exemptions. : **Field**: `last_modified_by_type` `last_modified_at` -: A list of modified_at timestamps of the exemptions. +: A list of `modified_at` timestamps of the exemptions. : **Field**: `last_modified_at` +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} -{{% inspec_filter_table %}} +{{< /note>}} ## Examples -**Loop through Policy Exemptions by Their Names.** +### Loop through Policy Exemptions by their names ```ruby azure_policy_exemptions.names.each do |name| describe azure_policy_exemption(name: name) do it { should exist } end -end -``` -**Test that There are Policy Exemptions that are of waiver exemption category .** +end +``` + +### Test that there are Policy Exemptions that are of waiver exemption category ```ruby describe azure_policy_exemptions.where(exemption_category: 'Waiver') do it { should exist } end -``` +``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -### exists +This resource has the following special matchers. + +### not_exists ```ruby -# Should not exist if no policy exemptions are present in the subscription +# Should not exist if no policy exemptions are present in the subscription. describe azure_policy_exemptions do it { should_not exist } end +``` -# Should exist if the filter returns at least one policy exemption in the subscription +### exists + +```ruby +# Should exist if the filter returns at least one policy exemption in the subscription. describe azure_policy_exemptions do it { should exist } @@ -162,4 +173,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_insights_query_result.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_insights_query_result.md index c5b687b603..cd8167d04f 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_insights_query_result.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_insights_query_result.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_policy_insights_query_result Resource parent = "inspec/resources/azure" +++ -Use the `azure_policy_insights_query_result` InSpec audit resource to test properties and configuration of an Azure Policy Insights query result. +Use the `azure_policy_insights_query_result` InSpec audit resource to test the properties and configuration of an Azure Policy Insights query result. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`policy_definition` and the `resource_id` must be given as a parameter. +The `policy_definition` and the `resource_id` are required parameters. ```ruby describe azure_policy_insights_query_result(policy_definition: 'de875639-505c-4c00-b2ab-bb290dab9a54', resource_id: '/subscriptions/80b824de-ec53-4116-9868-3deeab10b0cd/resourcegroups/jfm-winimgbuilderrg2/providers/microsoft.virtualmachineimages/imagetemplates/win1021h1') do @@ -45,6 +45,7 @@ end : The unique resource ID. `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderId}`. Submit both parameters for a valid query: + - `resource_id` - `policy_definition` @@ -66,7 +67,7 @@ Submit both parameters for a valid query: : Policy definition name. `policy_definition_action` -: Policy definition action, i.e. effect. +: Policy definition action. For example, `effect`. `compliance_state` : Compliance state of the resource. @@ -75,7 +76,13 @@ Submit both parameters for a valid query: : Effective parameters for the policy assignment. `is_compliant` -: Flag which states whether the resource is compliant against the policy assignment it was evaluated against. This property is deprecated; please use ComplianceState instead. +: Flag indicating whether the resource is compliant against the policy assignment it was evaluated. + +{{< note >}} + +This property is deprecated; please use `ComplianceState` instead. + +{{< /note >}} `policy_assignment_owner` : Policy assignment owner. @@ -105,17 +112,16 @@ Submit both parameters for a valid query: : Policy definition category. `management_group_ids` -: Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under. +: Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is part of. `compliance_reason_code` : Populated with the failure error code sometimes. -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/policy/policystates/listqueryresultsforsubscription#policystate) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/policy/policystates/listqueryresultsforsubscription#policystate) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test a Policy definition resource type.** +### Test a policy definition resource type ```ruby describe azure_policy_insights_query_result(policy_definition: 'de875639-505c-4c00-b2ab-bb290dab9a54', resource_id: '/subscriptions/80b824de-ec53-4116-9868-3deeab10b0cd/resourcegroups/jfm-winimgbuilderrg2/providers/microsoft.virtualmachineimages/imagetemplates/win1021h1') do @@ -123,7 +129,7 @@ describe azure_policy_insights_query_result(policy_definition: 'de875639-505c-4c end ``` -**Test a Policy definition policy assignment scope.** +### Test a policy definition and policy assignment scope ```ruby describe azure_policy_insights_query_result(policy_definition: 'de875639-505c-4c00-b2ab-bb290dab9a54', resource_id: '/subscriptions/80b824de-ec53-4116-9868-3deeab10b0cd/resourcegroups/jfm-winimgbuilderrg2/providers/microsoft.virtualmachineimages/imagetemplates/win1021h1') do @@ -133,7 +139,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### compliant @@ -148,12 +156,17 @@ end ### exists ```ruby -# If we expect a resource to always exist +# If we expect a resource to always exist. describe azure_policy_insights_query_result(policy_definition: 'de875639-505c-4c00-b2ab-bb290dab9a54', resource_id: '/subscriptions/80b824de-ec53-4116-9868-3deeab10b0cd/resourcegroups/jfm-winimgbuilderrg2/providers/microsoft.virtualmachineimages/imagetemplates/win1021h1') do it { should exist } end -# If we expect a resource to never exist +``` + +### not_exists + +```ruby +# If we expect a resource to never exist. describe azure_policy_insights_query_result(policy_definition: 'de875639-505c-4c00-b2ab-bb290dab9a54', resource_id: '/subscriptions/80b824de-ec53-4116-9868-3deeab10b0cd/resourcegroups/jfm-winimgbuilderrg2/providers/microsoft.virtualmachineimages/imagetemplates/win1021h1') do it { should_not exist } @@ -162,4 +175,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_insights_query_results.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_insights_query_results.md index d885dc959e..85afaa38d4 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_insights_query_results.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_policy_insights_query_results.md @@ -14,15 +14,15 @@ Use the `azure_policy_insights_query_results` InSpec audit resource to test prop ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_policy_insights_query_results` resource block returns all policy insights query results, either compliant, or not within a subscription. +An `azure_policy_insights_query_results` resource block returns all policy insights query results, compliant or not, within a subscription. ```ruby describe azure_policy_insights_query_results do @@ -30,7 +30,7 @@ describe azure_policy_insights_query_results do end ``` -or +Or ```ruby describe azure_policy_insights_query_results do @@ -50,37 +50,37 @@ This resource does not require any parameters. : **Field**: `resource_id` `policy_assignment_ids` -: A list of all Policy assignment IDs. +: A list of all policy assignment IDs. : **Field**: `policyAssignment_id` `policy_definition_ids` -: A list of all Policy definition IDs. +: A list of all policy definition IDs. : **Field**: `policyDefinition_id` `is_compliant` -: A list of boolean flags which states whether the resource is compliant or not. +: A list of boolean flags indicating whether the resource is compliant or not. : **Field**: `is_compliant` `subscription_ids` -: A list of Subscription IDs. +: A list of subscription IDs. : **Field**: `subscription_id` `resource_types` -: A list of Resource types. +: A list of resource types. : **Field**: `resource_type` `resource_locations` -: A list of Resource locations. +: A list of resource locations. : **Field**: `resource_location` `resource_groups` -: A list of Resource group names. +: A list of resource group names. : **Field**: `resource_group` @@ -90,32 +90,32 @@ This resource does not require any parameters. : **Field**: `resource_tags` `policy_assignment_names` -: A list of Policy assignment names. +: A list of policy assignment names. : **Field**: `policy_assignment_name` `policy_definition_names` -: A list of Policy definition names. +: A list of policy definition names. : **Field**: `policy_definition_name` `policy_assignment_scopes` -: A list of Policy assignment scopes. +: A list of policy assignment scopes. : **Field**: `policy_assignment_scope` `policy_assignment_parameters` -: A list of policy assignment parameter. +: A list of policy assignment parameters. : **Field**: `policy_assignment_parameters` `policy_definition_actions` -: A list of Policy definition actions. +: A list of policy definition actions. : **Field**: `policy_definition_action` `policy_definition_categories` -: A list of Policy definition categories. +: A list of policy definition categories. : **Field**: `policy_definition_category` @@ -134,11 +134,15 @@ This resource does not require any parameters. : **Field**: `compliance_reason_code` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check if a specific resource type is present.** +### Check if a specific resource type is present ```ruby describe azure_policy_insights_query_results do @@ -146,7 +150,7 @@ describe azure_policy_insights_query_results do end ``` -**Filters the results to include only those Policy Insights query results which include the given resource location.** +### Filters the results to include only those Policy Insights query results that have specified location ```ruby describe azure_policy_insights_query_results.where(resource_location: 'RESOURCE_LOCATION') do @@ -154,7 +158,7 @@ describe azure_policy_insights_query_results.where(resource_location: 'RESOURCE_ end ``` -**Filters the results to include only the compliant Policy Insights query results.** +### Filters the results to include only the compliant Policy Insights query results ```ruby describe azure_policy_insights_query_results.where(is_compliant: true) do @@ -165,11 +169,13 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect **zero** matches. ```ruby describe azure_policy_insights_query_results do @@ -179,4 +185,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_database.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_database.md index 659d719efe..b7e2fc6443 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_database.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_database.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_postgresql_database Resource" parent = "inspec/resources/azure" +++ -Use the `azure_postgresql_database` InSpec audit resource to test properties and configuration of an Azure PostgreSQL Database on a PostgreSQL Server. +Use the `azure_postgresql_database` InSpec audit resource to test the properties and configuration of an Azure PostgreSQL database on a PostgreSQL server. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group`, `server_name` and `name` or the `resource_id` must be given as a parameter. +`resource_group`, `server_name` and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_postgresql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do +describe azure_postgresql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DATABASE_NAME') do it { should exist } end ``` + ```ruby describe azure_postgresql_database(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases/{databaseName}') do it { should exist } @@ -37,13 +39,13 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `server_name` -: The name of the server on which the database resides. `serverName`. +: The name of the server on which the database resides. `name` -: The unique name of the database. `databaseName`. +: The unique name of the database. `database_name` : Alias for the `name` parameter. @@ -52,6 +54,7 @@ end : The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases/{databaseName}`. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group`, `server_name`, and `name` - `resource_group`, `server_name`, and `database_name` @@ -61,20 +64,21 @@ Either one of the parameter sets can be provided for a valid query: `properties.charset` : The charset of the database. -For properties applicable to all resources, such as `type`, `tags`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `tags`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/postgresql/databases/get#database) for other properties available. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/postgresql/flexibleserver(preview)/databases/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test the Name of a Resource.** +### Test the resource name ```ruby -describe azure_postgresql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do +describe azure_postgresql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DATABASE_NAME') do its('name') { should be 'order-db' } end ``` + ```ruby describe azure_postgresql_database(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases/order-db') do its('name') { should be 'order-db' } @@ -88,19 +92,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect the resource to always exist +# If we expect the resource to always exist. -describe azure_postgresql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do +describe azure_postgresql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DATABASE_NAME') do it { should exist } end +``` + +### not_exists -# If we expect the resource to never exist +```ruby +# If we expect the resource to never exist. -describe azure_postgresql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do +describe azure_postgresql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DATABASE_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_databases.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_databases.md index 9cd9be1e75..f75aeceb4e 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_databases.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_databases.md @@ -10,21 +10,22 @@ identifier = "inspec/resources/azure/azure_postgresql_databases Resource" parent = "inspec/resources/azure" +++ -Use the `azure_postgresql_databases` InSpec audit resource to test properties and configuration of Azure PostgreSQL Databases. +Use the `azure_postgresql_databases` InSpec audit resource to test the properties and configuration of Azure PostgreSQL Databases. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -The `resource_group`, and `server_name` must be given as a parameter. +The `resource_group` and `server_name` are required parameters. + ```ruby -describe azure_postgresql_databases(resource_group: 'my-rg', server_name: 'my-server') do +describe azure_postgresql_databases(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do it { should exist } end ``` @@ -32,15 +33,15 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `server_name` -: The name of the server in which the database resides. `serverName`. +: The name of the server in which the database resides. ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -64,47 +65,59 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check Resources are Present.** +### Check resources are present ````ruby -describe azure_postgresql_databases(resource_group: 'my-rg', server_name: 'my-server') do +describe azure_postgresql_databases(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do it { should exist } its('names') { should include 'my-db' } end ```` -**Filter the Results to Include Only those with Names Match the Given String Value.** + +### Filter the results to include only those with names that match the specified string value ```ruby -describe azure_postgresql_databases.(resource_group: 'my-rg', server_name: 'my-server').where{ name.eql?('production-db') } do +describe azure_postgresql_databases.(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME').where{ name.eql?('production-db') } do it { should exist } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect **zero** matches. + ```ruby -# If we expect resources to exist +# If we expect resources to exist. -describe azure_postgresql_databases(resource_group: 'ExampleGroup', server_name: 'my-server') do +describe azure_postgresql_databases(resource_group: 'EXAMPLEGROUP', server_name: 'SERVER_NAME') do it { should exist } end +``` -# If we expect resources not to exist +### not_exists + +```ruby +# If we expect resources not to exist. -describe azure_postgresql_databases(resource_group: 'ExampleGroup', server_name: 'my-server') do +describe azure_postgresql_databases(resource_group: 'EXAMPLEGROUP', server_name: 'SERVER_NAME) do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_server.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_server.md index 0c958995d0..c926ca8142 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_server.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_server.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_postgresql_server Resource" parent = "inspec/resources/azure" +++ -Use the `azure_postgresql_server` InSpec audit resource to test properties and configuration of an Azure PostgreSql Server. +Use the `azure_postgresql_server` InSpec audit resource to test the properties and configuration of an Azure PostgreSql server. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `name` or the `resource_id` must be given as a parameter. +`resource_group` and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_postgresql_server(resource_group: 'inspec-resource-group-9', name: 'example_server') do +describe azure_postgresql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do it { should exist } end ``` + ```ruby describe azure_postgresql_server(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}') do it { should exist } @@ -37,21 +39,22 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: Name of the PostgreSql server to test. `MyServer`. +: Name of the PostgreSql server to test. `server_name` : Alias for the `name` parameter. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}`. +: The unique resource ID. `configurations_api_version` -: The endpoint api version for the `configurations` property. The latest version will be used unless provided. +: The endpoint API version for the `configurations` property. The latest version will be used unless provided. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` - `resource_group` and `server_name` @@ -59,47 +62,53 @@ Either one of the parameter sets can be provided for a valid query: ## Properties `configurations` -: An object containing all the configurations of a DB server available through [configurations](https://docs.microsoft.com/en-us/rest/api/postgresql/configurations/listbyserver) endpoint. Configuration values can be accessed as following, `configurations.client_encoding.properties.value`, `configurations.deadlock_timeout.properties.value`, etc. +: An object containing all the configurations of a DB server available through [configurations](https://docs.microsoft.com/en-us/rest/api/postgresql/singleserver/configurations/list-by-server) endpoint. Configuration values can be accessed as follows, `configurations.client_encoding.properties.value`, `configurations.deadlock_timeout.properties.value`, and so on. `sku` : The SKU (pricing tier) of the server. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +`firewall_rules` +: An object of firewall rules applied on postgresql server. -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/postgresql/servers/get#server) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/postgresql/flexibleserver(preview)/servers/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test the Administrator's Login Name of a PostgreSql Server.** +### Test the administrator's login name of a PostgreSql server ```ruby -describe azure_postgresql_server(resource_group: 'my-rg', name: 'sql-server-1') do +describe azure_postgresql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do its('properties.administratorLogin') { should cmp 'admin' } end ``` -**Test the Fully Qualified Domain Name of a PostgreSql Server.** + +### Test the fully qualified domain name of a PostgreSql server ```ruby -describe azure_postgresql_server(resource_group: 'my-rg', name: 'i-dont-exist') do +describe azure_postgresql_server(resource_group: 'RESOURCE_GROUP', name: 'i-dont-exist') do its('properties.fullyQualifiedDomainName') { should cmp 'pgtestsvc1.postgres.database.azure.com' } end -``` -**Test the Client Encoding Configuration Value of a PostgreSql Server.** +``` + +### Test the client encoding configuration value of a PostgreSql server ```ruby -describe azure_postgresql_server(resource_group: 'my-rg', name: 'my-server') do +describe azure_postgresql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do its('configurations.client_encoding.properties.value') { should cmp 'sql_ascii' } end -``` -**Test the Deadlock Timeout Configuration Value of a PostgreSql Server.** +``` + +### Test the deadlock timeout configuration value of a PostgreSql server ```ruby -describe azure_postgresql_server(resource_group: 'my-rg', name: 'my-server') do +describe azure_postgresql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do its('configurations.deadlock_timeout.properties.value') { should cmp '1000' } end -``` -**Test a PostgreSql Server's Location and Maximum Replica Capacity.** +``` + +### Test a PostgreSql server's location and maximum replica capacity ```ruby describe azure_postgresql_server(resource_id: '/subscriptions/.../my-server') do @@ -107,26 +116,39 @@ describe azure_postgresql_server(resource_id: '/subscriptions/.../my-server') do its('location') { should cmp 'westeurope' } end ``` +### Test a PostgreSql server's firewall rules +```ruby +describe azure_postgresql_server(resource_id: '/subscriptions/.../my-server') do + its('firewall_rules') { should eq {} } +end +``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# If we expect a resource to always exist +# If we expect a resource to always exist. -describe azure_postgresql_server(resource_group: 'my-rg', server_name: 'server-name-1') do +describe azure_postgresql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do it { should exist } end -# If we expect a resource to never exist +``` + +### not_exists + +```ruby +# If we expect a resource to never exist. -describe azure_postgresql_server(resource_group: 'my-rg', server_name: 'server-name-1') do +describe azure_postgresql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_servers.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_servers.md index 20c530ec02..b6b00f9327 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_servers.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_postgresql_servers.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_postgresql_servers Resource" parent = "inspec/resources/azure" +++ -Use the `azure_postgresql_servers` InSpec audit resource to test properties and configuration of multiple Azure PostgreSQL Servers. +Use the `azure_postgresql_servers` InSpec audit resource to test the properties and configuration of multiple Azure PostgreSQL servers. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_postgresql_servers` resource block returns all Azure PostgreSQL Servers, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_postgresql_servers` resource block returns all Azure PostgreSQL servers within a resource group (if provided) or an entire subscription. + ```ruby describe azure_postgresql_servers do it { should exist } end ``` -or + +Or + ```ruby -describe azure_postgresql_servers(resource_group: 'my-rg') do +describe azure_postgresql_servers(resource_group: 'RESOURCE_GROUP') do it { should exist } end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -78,46 +81,56 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check a Specific PostgreSQL Server is Present.** +### Check a specific PostgreSQL server is present ```ruby describe azure_postgresql_servers do its('names') { should include 'my-server-name' } end ``` -**Filters the Results to Include Only Those Servers which Include the Given Name (Client Side Filtering).** + +### Filters the results to include only those servers having specified names (Client Side Filtering) ```ruby describe azure_postgresql_servers.where{ name.include?('production') } do it { should exist } end ``` -**Filters the Results to Include Only Those Servers which Reside in a Given Location (Client Side Filtering).** + +### Filters the results to include only those servers residing in a specified location (Client Side Filtering) ```ruby describe azure_postgresql_servers.where{ location.eql?('westeurope') } do it { should exist } end -``` -**Filters the Results to Include Only Those Servers which Reside in a Given Location and Include the Given Name (Server Side Filtering - Recommended).** +``` + +### Filters the results to include only those servers residing in a specified location and has the specified name (Server Side Filtering - Recommended) ```ruby describe azure_generic_resources(resource_provider: 'Microsoft.DBforPostgreSQL/servers', substring_of_name: 'production', location: 'westeurope') do - it {should exist} + it {should exist} end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect **zero** matches. + ```ruby describe azure_postgresql_servers do it { should exist } @@ -126,4 +139,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app.md index 5c40ae9524..1434c8eb2c 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app.md @@ -14,11 +14,11 @@ Use the `azure_power_bi_app` InSpec audit resource to test the properties relate ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -59,7 +59,7 @@ Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/p ## Examples -**Test that the Power BI app is published by inspec-devs.** +### Test that the Power BI app is published by inspec-devs ```ruby describe azure_power_bi_app(app_id: 'APP_ID') do @@ -74,11 +74,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If the Azure Power BI app is found, it will exist +# If the Azure Power BI app is found, it will exist. + describe azure_power_bi_app(app_id: 'APP_ID') do it { should exist } end -# if the Azure Power BI app is not found, it will not exist +``` + +### not_exists + +```ruby +# if the Azure Power BI app is not found, it will not exist. + describe azure_power_bi_app(app_id: 'APP_ID') do it { should_not exist } end diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboard.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboard.md new file mode 100644 index 0000000000..cca2d4b46f --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboard.md @@ -0,0 +1,95 @@ ++++ +title = "azure_power_bi_app_dashboard Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_power_bi_app_dashboard" +identifier = "inspec/resources/azure/azure_power_bi_app_dashboard Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_power_bi_app_dashboard` InSpec audit resource to test the properties of an Azure Power BI app dashboard. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +```ruby +describe azure_power_bi_app_dashboard(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID') do + it { should exist } +end +``` + +## Parameters + +`app_id` _(required)_ +: The app ID. + +`dashboard_id` _(required)_ +: The app dashboard ID. + +## Properties + +`id` +: The app ID. + +`displayName` +: The dashboard display name. + +`embedUrl` +: The dashboard embed URL. + +`isReadOnly` +: Is ReadOnly dashboard. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/apps/get-dashboard) for other properties available. + +## Examples + +### Test that the Power BI app dashboard is read-only + +```ruby +describe azure_power_bi_app_dashboard(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID') do + its('isReadOnly') { should eq true } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If the Azure Power BI app dashboard is found, it will exist. +describe azure_power_bi_app_dashboard(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID') do + it { should exist } +end +``` + +### not_exists + +```ruby +# if the Azure Power BI app dashboard is not found, it will not exist. + +describe azure_power_bi_app_dashboard(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID') do + it { should_not exist } +end +``` + +## Azure Permissions + +This API does not support service principal authentication. Instead, use the Active Directory (AD) account access token to access this resource. +Your AD account must be set up with a `Dashboard.Read.All` role on the Azure Power BI workspace you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboard_tile.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboard_tile.md index ef4d5e806f..f4b25b8c6d 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboard_tile.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboard_tile.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_power_bi_app_dashboard_tile Resource" parent = "inspec/resources/azure" +++ -Use the `azure_power_bi_app_dashboard_tile` InSpec audit resource to test the properties related to Azure Power BI App dashboard tile. +Use the `azure_power_bi_app_dashboard_tile` InSpec audit resource to test the properties related to an Azure Power BI app dashboard tile. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`app_id`, `dashboard_id` and `tile_id` is a required parameter. +`app_id`, `dashboard_id`, and `tile_id` are required parameters. ```ruby describe azure_power_bi_app_dashboard_tile(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID', tile_id: 'TILE_ID') do @@ -38,11 +38,11 @@ end `dashboard_id` _(required)_ -: The App Dashboard ID. +: The app Dashboard ID. `tile_id` _(required)_ -: The App dashboard tile ID. +: The app dashboard tile ID. ## Properties @@ -53,7 +53,7 @@ end : The dashboard display name. `embedUrl` -: The tile embed url. +: The tile embed URL. `rowSpan` : number of rows a tile should span. @@ -73,7 +73,7 @@ Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/p ## Examples -**Test that the Power BI App dashboard tile is at the left corner.** +### Test that the Power BI app dashboard tile is at the left corner ```ruby describe azure_power_bi_app_dashboard_tile(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID', tile_id: 'TILE_ID') do @@ -89,11 +89,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If the Azure Power BI App dashboard tile is found, it will exist +# If the Azure Power BI app dashboard tile is found, it will exist. + describe azure_power_bi_app_dashboard_tile(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID', tile_id: 'TILE_ID') do it { should exist } end -# if the Azure Power BI App dashboard tile is not found, it will not exist +``` + +### not_exists + +```ruby +# if the Azure Power BI app dashboard tile is not found, it will not exist. + describe azure_power_bi_app_dashboard_tile(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID', tile_id: 'TILE_ID') do it { should_not exist } end @@ -102,4 +109,4 @@ end ## Azure Permissions This API does not support service principal authentication. Instead, use an Active Directory account access token to access this resource. -Your Active Directory account must be set up with a `Dashboard.Read.All` role on the Azure Power BI workspace that you wish to test. +Your Active Directory account must be set up with a `Dashboard.Read.All` role on the Azure Power BI workspace you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboard_tiles.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboard_tiles.md index d04e996e6c..50a7666a82 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboard_tiles.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboard_tiles.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_power_bi_app_dashboard_tiles Resource parent = "inspec/resources/azure" +++ -Use the `azure_power_bi_app_dashboard_tiles` InSpec audit resource to test the properties related to all Azure Power BI App dashboard tiles. +Use the `azure_power_bi_app_dashboard_tiles` InSpec audit resource to test the properties related to all Azure Power BI app dashboard tiles. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_power_bi_app_dashboard_tiles` resource block returns all Azure Power BI App dashboard tiles. +An `azure_power_bi_app_dashboard_tiles` resource block returns all Azure Power BI app dashboard tiles. ```ruby describe azure_power_bi_app_dashboard_tiles(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID') do @@ -38,22 +38,22 @@ end `dashboard_id` _(required)_ -: The App Dashboard ID. +: The app Dashboard ID. ## Properties `ids` -: List of all App dashboard tile IDs. +: List of all app dashboard tile IDs. : **Field**: `id` `titles` -: List of all the dashboard title. +: List of all the dashboard titles. : **Field**: `title` `embedUrls` -: List of all the dashboard embed urls. +: List of all the dashboard embed URLs. : **Field**: `embedUrl` @@ -77,12 +77,16 @@ end : **Field**: `datasetId` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/apps/get-tiles) for other properties available. ## Examples -**Loop through Power BI App dashboard tiles by their IDs.** +### Loop through Power BI app dashboard tiles by their IDs ```ruby azure_power_bi_app_dashboard_tiles(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID').ids.each do |id| @@ -92,7 +96,7 @@ azure_power_bi_app_dashboard_tiles(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID end ``` -**Test to filter out Power BI App dashboard tiles that are in left corner.** +### Test to filter out Power BI app dashboard tiles that are in the left corner ```ruby describe azure_power_bi_app_dashboard_tiles(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID').where(rowSpan: 0, colSpan: 0) do @@ -102,7 +106,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists @@ -114,6 +120,8 @@ describe azure_power_bi_app_dashboard_tiles(app_id: 'APP_ID') do end ``` +### not_exists + Use `should_not` to test that the entity does not exist. ```ruby @@ -125,4 +133,4 @@ end ## Azure Permissions This API does not support service principal authentication. Instead, use an Active Directory account access token to access this resource. -Your Active Directory account must be set up with a `Dashboard.Read.All` role on the Azure Power BI workspace that you wish to test. +Your Active Directory account must be set up with a `Dashboard.Read.All` role on the Azure Power BI workspace you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboards.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboards.md new file mode 100644 index 0000000000..230d1b05a4 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_dashboards.md @@ -0,0 +1,116 @@ ++++ +title = "azure_power_bi_app_dashboards Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_power_bi_app_dashboards" +identifier = "inspec/resources/azure/azure_power_bi_app_dashboards Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_power_bi_app_dashboards` InSpec audit resource to test the properties of all Azure Power BI app dashboards. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_power_bi_app_dashboards` resource block returns all Azure Power BI app dashboards. + +```ruby +describe azure_power_bi_app_dashboards(app_id: 'APP_ID') do + #... +end +``` + +## Parameters + +`app_id` _(required)_ +: The app ID. + +## Properties + +`ids` +: List of all app IDs. + +: **Field**: `id` + +`displayNames` +: List of all the dashboard display names. + +: **Field**: `displayName` + +`embedUrls` +: List of all the dashboard embed URLs. + +: **Field**: `embedUrl` + +`isReadOnlies` +: List of all the boolean read-only dashboard flags. + +: **Field**: `isReadOnly` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/apps/get-dashboards) for other properties available. + +## Examples + +### Loop through Power BI app dashboards by their IDs + +```ruby +azure_power_bi_app_dashboards(app_id: 'APP_ID').ids.each do |id| + describe azure_power_bi_app_dashboard(app_id: 'APP_ID', dashboard_id: id) do + it { should exist } + end +end +``` + +### Test to filter out Power BI app dashboards that are read-only + +```ruby +describe azure_power_bi_app_dashboards(app_id: 'APP_ID').where(isReadOnly: true) do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no Power BI apps are present. + +describe azure_power_bi_app_dashboards(app_id: 'APP_ID') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Power BI app. + +describe azure_power_bi_app_dashboards(app_id: 'APP_ID') do + it { should exist } +end +``` + +## Azure Permissions + +This API does not support service principal authentication. Instead, use the Active Directory (AD) account access token to access this resource. +Your AD account must be set up with a `Dashboard.Read.All` role on the Azure Power BI workspace you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_report.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_report.md new file mode 100644 index 0000000000..8a3f2400d1 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_report.md @@ -0,0 +1,105 @@ ++++ +title = "azure_power_bi_app_report Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_power_bi_app_report" +identifier = "inspec/resources/azure/azure_power_bi_app_report Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_power_bi_app_report` InSpec audit resource to test the properties related to an Azure Power BI app report. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +```ruby +describe azure_power_bi_app_report(app_id: 'APP_ID', report_id: 'REPORT_ID') do + it { should exist } +end +``` + +## Parameters + +`app_id` _(required)_ + +: The app ID. + +`report_id` _(required)_ + +: The app report ID. + +## Properties + +`id` +: The report ID. + +`appId` +: The app ID. + +`embedUrl` +: The report embed URL. + +`datasetId` +: The dataset ID. + +`name` +: The report name. + +`webUrl` +: The report web URL. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/apps/get-report) for other properties available. + +## Examples + +### Test that the Power BI app report is paginated and embed URL is present + +```ruby +describe azure_power_bi_app_report(app_id: 'APP_ID', report_id: 'REPORT_ID') do + its('reportType') { should eq 'PaginatedReport' } + its('embedUrl') { should_not be_empty } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +Use `should` to test that the entity exists. + +```ruby +describe azure_power_bi_app_report(app_id: 'APP_ID', report_id: 'REPORT_ID') do + it { should exist } +end +``` + +### not_exists + +Use `should_not` to test that the entity does not exist. + +```ruby +describe azure_power_bi_app_report(app_id: 'APP_ID', report_id: 'REPORT_ID') do + it { should_not exist } +end +``` + +## Azure Permissions + +This API does not support service principal authentication. Instead, use an Active Directory account access token to access this resource. +Your Active Directory account must be set up with a `Report.Read.All` role on the Azure Power BI workspace you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_reports.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_reports.md new file mode 100644 index 0000000000..10d2d2d031 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_app_reports.md @@ -0,0 +1,127 @@ ++++ +title = "azure_power_bi_app_reports Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_power_bi_app_reports" +identifier = "inspec/resources/azure/azure_power_bi_app_reports Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_power_bi_app_reports` InSpec audit resource to test the properties related to all Azure Power BI app reports. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_power_bi_app_reports` resource block returns all Azure Power BI app reports. + +```ruby +describe azure_power_bi_app_reports(app_id: 'APP_ID') do + #... +end +``` + +## Parameters + +`app_id` _(required)_ + +: The app ID. + +## Properties + +`ids` +: List of all app report IDs. + +: **Field**: `id` + +`embedUrls` +: List of all the report embed URLs. + +: **Field**: `embedUrl` + +`appIds` +: List of all the app IDs. + +: **Field**: `appId` + +`datasetIds` +: List of all the Dataset IDs. + +: **Field**: `datasetId` + +`names` +: List of all the report names. + +: **Field**: `name` + +`webUrls` +: List of all the report web URLs. + +: **Field**: `webUrl` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/apps/get-reports) for other properties available. + +## Examples + +### Loop through Power BI app reports by their IDs + +```ruby +azure_power_bi_app_reports(app_id: 'APP_ID').ids.each do |id| + describe azure_power_bi_app_report(app_id: 'APP_ID', report_id: id) do + it { should exist } + end +end +``` + +### Test to filter out Power BI app reports by report name + +```ruby +describe azure_power_bi_app_reports(app_id: 'APP_ID').where(name: 'REPORT_NAME') do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no Power BI app reports are present. + +describe azure_power_bi_app_reports(app_id: 'APP_ID') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Power BI app reports. + +describe azure_power_bi_app_reports(app_id: 'APP_ID') do + it { should exist } +end +``` + +## Azure Permissions + +This API does not support service principal authentication. Instead, use an Active Directory account access token to access this resource. +Your Active Directory account must be set up with a `Report.Read.All` role on the Azure Power BI workspace you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_apps.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_apps.md index b76e847a99..5803188818 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_apps.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_apps.md @@ -14,11 +14,11 @@ Use the `azure_power_bi_apps` InSpec audit resource to test the properties relat ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -56,13 +56,16 @@ This resource does not require any parameters. : **Field**: `lastUpdate` +{{< note >}} -{{% inspec_filter_table %}} +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/apps/get-apps) for other properties available. ## Examples -**Loop through Power BI apps by their IDs.** +### Loop through Power BI apps by their IDs ```ruby azure_power_bi_apps.ids.each do |id| @@ -72,7 +75,7 @@ azure_power_bi_apps.ids.each do |id| end ``` -**Test that a Power BI app named "Finance" exists.** +### Test that a Power BI app named 'Finance' exists ```ruby describe azure_power_bi_apps.where(name: 'Finance') do @@ -82,17 +85,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Power BI apps are present +# Should not exist if no Power BI apps are present. describe azure_power_bi_apps do it { should_not exist } end -# Should exist if the filter returns at least one Power BI apps +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Power BI apps. describe azure_power_bi_apps do it { should exist } diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacities.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacities.md index 0e31e4b6db..2db67814d4 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacities.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacities.md @@ -14,11 +14,11 @@ Use the `azure_power_bi_app_capacities` InSpec audit resource to test the proper ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -71,12 +71,17 @@ This resource does not require any parameters. : **Field**: `capacityUserAccessRight` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/capacities/get-capacities) for other properties available. ## Examples -**Test to ensure Power BI capacities are active.** +### Test to ensure Power BI capacities are active ```ruby describe azure_power_bi_app_capacities.where(state: 'Active') do @@ -86,7 +91,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists @@ -98,6 +105,8 @@ describe azure_power_bi_app_capacities do end ``` +### not_exists + Use `should_not` to test that the entity does not exist. ```ruby @@ -109,4 +118,4 @@ end ## Azure Permissions This API does not support service principal authentication. Instead, use an Active Directory account access token to access this resource. -Your Active Directory account must be set up with a `Capacity.Read.All` role on the Azure Power BI workspace that you wish to test. +Your Active Directory account must be set up with a `Capacity.Read.All` role on the Azure Power BI workspace you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_refreshable.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_refreshable.md index ee3f16958f..fc3f37de1a 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_refreshable.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_refreshable.md @@ -14,11 +14,11 @@ Use the `azure_power_bi_capacity_refreshable` InSpec audit resource to test the ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -53,7 +53,7 @@ end : The refreshable kind. `name` -: Display name of refreshable. +: Display refreshable name. `startTime` : The start time of the window for which summary data exists. @@ -76,14 +76,13 @@ end `refreshSchedule.enabled` : Is the refresh enabled. - For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/capacities/get-refreshable-for-capacity) for other properties available. ## Examples -**Test that the Power BI Capacity refreshable schedule is enabled.** +### Test that the Power BI Capacity refreshable schedule is enabled ```ruby describe azure_power_bi_capacity_refreshable(capacity_id: 'CAPACITY_ID', name: 'REFRESHABLE_ID') do @@ -98,11 +97,17 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If the Power BI Capacity refreshable is found, it will exist +# If the Power BI Capacity refreshable is found, it will exist. + describe azure_power_bi_capacity_refreshable(capacity_id: 'CAPACITY_ID', name: 'REFRESHABLE_ID') do it { should exist } end -# if the Power BI Capacity refreshable is not found, it will not exist +``` + +### not_exists + +```ruby +# if the Power BI Capacity refreshable is not found, it will not exist. describe azure_power_bi_capacity_refreshable(capacity_id: 'CAPACITY_ID', name: 'REFRESHABLE_ID') do it { should_not exist } end diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_refreshables.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_refreshables.md index 830b30f3fd..4818ef1011 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_refreshables.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_refreshables.md @@ -14,11 +14,11 @@ Use the `azure_power_bi_capacity_refreshables` InSpec audit resource to test the ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -33,24 +33,22 @@ end ## Parameters `capacity_id` _(optional)_ - : The capacity ID. - ## Properties `ids` -: List of all Power Bi Capacity refreshable IDs. +: List of all Power BI Capacity refreshable IDs. : **Field**: `id` `names` -: List of all the Power Bi Capacity refreshable names. +: List of all the Power BI Capacity refreshable names. : **Field**: `name` `kinds` -: List of all the Power Bi Capacity refreshable kinds. +: List of all the Power BI Capacity refreshable kinds. : **Field**: `kind` @@ -79,13 +77,17 @@ end : **Field**: `averageDuration` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} For additional information, refer to the [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/capacities/get-refreshables) for other properties available. ## Examples -**Test to ensure Power BI Capacity refreshable schedules are enabled.** +### Test to ensure Power BI Capacity refreshable schedules are enabled ```ruby describe azure_power_bi_capacity_refreshables do @@ -95,16 +97,23 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Power BI Capacity refreshables are present +# Should not exist if no Power BI Capacity refreshables are present. describe azure_power_bi_capacity_refreshables do it { should_not exist } end +``` + +### not_exists + +```ruby # Should exist if the filter returns at least one Power BI Capacity refreshables describe azure_power_bi_capacity_refreshables do diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_workload.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_workload.md new file mode 100644 index 0000000000..c4a3f8d5bb --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_workload.md @@ -0,0 +1,100 @@ ++++ +title = "azure_power_bi_capacity_workload Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_power_bi_capacity_workload" +identifier = "inspec/resources/azure/azure_power_bi_capacity_workload Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_power_bi_capacity_workload` InSpec audit resource to test the properties related to Azure Power BI Capacity workload. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +`name` and `capacity_id` are required parameters. + +```ruby +describe azure_power_bi_capacity_workload(capacity_id: 'CAPACITY_ID', name: 'WORKLOAD_NAME') do + it { should exist } +end +``` + +```ruby +describe azure_power_bi_capacity_workload(capacity_id: 'CAPACITY_ID', name: 'WORKLOAD_NAME') do + it { should exist } +end +``` + +## Parameters + +`name` _(required)_ +: The workload Name. + +`capacity_id` _(required)_ +: The capacity ID. + +## Properties + +`name` +: The workload name. + +`state` +: The capacity workload state. + +`maxMemoryPercentageSetByUser` +: The memory percentage maximum Limit set by the user. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/capacities/get-workload) for other properties available. + +## Examples + +### Test that the Power BI Capacity workload is enabled + +```ruby +describe azure_power_bi_capacity_workload(capacity_id: 'CAPACITY_ID', name: 'WORKLOAD_NAME') do + its('state') { should eq 'Enabled' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If the Power BI Capacity workload is found, it will exist. + +describe azure_power_bi_capacity_workload(capacity_id: 'CAPACITY_ID', name: 'WORKLOAD_NAME') do + it { should exist } +end +``` + +### not_exists + +```ruby +# if the Power BI Capacity workload is not found, it will not exist. + +describe azure_power_bi_capacity_workload(capacity_id: 'CAPACITY_ID', name: 'WORKLOAD_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `Capacity.Read.All` role on the Azure Power BI Capacity you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_workloads.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_workloads.md new file mode 100644 index 0000000000..1adeb345c4 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_capacity_workloads.md @@ -0,0 +1,100 @@ ++++ +title = "azure_power_bi_capacity_workloads Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_power_bi_capacity_workloads" +identifier = "inspec/resources/azure/azure_power_bi_capacity_workloads Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_power_bi_capacity_workloads` InSpec audit resource to test the properties related to all Azure Power BI Capacity workloads. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_power_bi_capacity_workloads` resource block returns all Azure Power BI Capacity workloads. + +```ruby +describe azure_power_bi_capacity_workloads(capacity_id: 'CAPACITY_ID') do + #... +end +``` + +## Parameters + +`capacity_id` +: The capacity ID. + +## Properties + +`states` +: List of all Power Bi Capacity Workload IDs. + +: **Field**: `state` + +`names` +: List of all the Power Bi Capacity Workload names. + +: **Field**: `name` + +`maxMemoryPercentageSetByUsers` +: List of all the Power Bi Capacity Workload Kinds. + +: **Field**: `maxMemoryPercentageSetByUser` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/capacities/get-Workloads) for other properties available. + +## Examples + +### Test to ensure Power BI Capacity Workload is enabled + +```ruby +describe azure_power_bi_capacity_workloads(capacity_id: 'CAPACITY_ID').where(state: 'Enabled') do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no Power BI Capacity Workloads are present. + +describe azure_power_bi_capacity_workloads(capacity_id: 'CAPACITY_ID') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Power BI Capacity Workloads. + +describe azure_power_bi_capacity_workloads(capacity_id: 'CAPACITY_ID') do + it { should exist } +end +``` + +## Azure Permissions + +Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `Capacity.Read.All` role on the Azure Power BI Capacity you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboard.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboard.md index 893c7bdd73..315244ff11 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboard.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboard.md @@ -14,15 +14,15 @@ Use the `azure_power_bi_dashboard` InSpec audit resource to test the properties ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`dashboard_id` is a required parameter and `group_id` is an optional parameter. +`dashboard_id` is a required parameter, and `group_id` is an optional parameter. ```ruby describe azure_power_bi_dashboard(group_id: 'GROUP_ID', dashboard_id: 'dashboard_ID') do @@ -49,7 +49,7 @@ end : The dashboard display name. `embedUrl` -: The dashboard embed url. +: The dashboard embed URL. `isReadOnly` : Is ReadOnly dashboard. @@ -60,7 +60,7 @@ Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/p ## Examples -**Test that the Power BI Dashboard is read only.** +### Test that the Power BI Dashboard is read-only ```ruby describe azure_power_bi_dashboard(group_id: 'GROUP_ID', dashboard_id: 'DASHBOARD_ID') do @@ -75,13 +75,17 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# Should exist if the Power BI dashboard is present in the group +# Should exist if the Power BI dashboard is present in the group. describe azure_power_bi_dashboard(group_id: 'GROUP_ID', dashboard_id: 'dashboard_ID') do it { should exist } end +``` + +### not_exists -# Should not exist if the Power BI dashboard is not present in the group +```ruby +# Should not exist if the Power BI dashboard is not present in the group. describe azure_power_bi_dashboard(group_id: 'GROUP_ID', dashboard_id: 'dashboard_ID') do it { should_not exist } diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboard_tile.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboard_tile.md index 927477f728..5eb08be3da 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboard_tile.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboard_tile.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_power_bi_dashboard_tile Resource" parent = "inspec/resources/azure" +++ -Use the `azure_power_bi_dashboard_tile` InSpec audit resource to test the properties related to Azure Power BI dashboard tile. +Use the `azure_power_bi_dashboard_tile` InSpec audit resource to test the properties related to an Azure Power BI dashboard tile. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -51,19 +51,19 @@ end : The dashboard display name. `embedUrl` -: The tile embed url. +: The tile embed URL. `rowSpan` -: number of rows a tile should span. +: The number of rows a tile should span. `colSpan` -: number of columns a tile should span. +: The number of columns a tile should span. `reportId` -: The report ID, which is available only for tiles created from a report. +: The report ID available only for tiles created from a report. `datasetId` -: The dataset ID, which is available only for tiles created from a report or using a dataset, such as Q&A tiles. +: The dataset ID available only for tiles created from a report or using a dataset, such as Q&A tiles. For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). @@ -71,7 +71,7 @@ Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/p ## Examples -**Test that the Power BI dashboard tile is on left corner.** +### Test that the Power BI dashboard tile is on the left corner ```ruby describe azure_power_bi_dashboard_tile(group_id: 'GROUP_ID', dashboard_id: 'dashboard_ID', title_id: 'TITLE_ID') do @@ -86,13 +86,17 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# Use should to test for an Azure Power BI dashboard tile that should be in the resource group +# Use should to test for an Azure Power BI dashboard tile that should be in the resource group. describe azure_power_bi_dashboard_tile(group_id: 'GROUP_ID', dashboard_id: 'dashboard_ID', title_id: 'TITLE_ID') do it { should exist } end +``` + +### not_exists -# Use should_not to test for an Azure Power BI dashboard tile that should not be in the resource group +```ruby +# Use should_not to test for an Azure Power BI dashboard tile that should not be in the resource group. describe azure_power_bi_dashboard_tile(group_id: 'GROUP_ID', dashboard_id: 'dashboard_ID', title_id: 'TITLE_ID') do it { should_not exist } diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboard_tiles.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboard_tiles.md index 6eb7b6b3e6..9f246a0b76 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboard_tiles.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboard_tiles.md @@ -14,15 +14,15 @@ Use the `azure_power_bi_dashboard_tiles` InSpec audit resource to test the prope ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_power_bi_dashboard_tiles` resource block returns all Azure Power BI dashboard tiles within dashboard and a group. +An `azure_power_bi_dashboard_tiles` resource block returns all Azure Power BI dashboard tiles within a dashboard and a group. ```ruby describe azure_power_bi_dashboard_tiles(dashboard_id: 'dashboard_ID') do @@ -57,7 +57,7 @@ end : **Field**: `title` `embedUrls` -: List of all dashboard embed urls. +: List of all dashboard embed URLs. : **Field**: `embedUrl` @@ -81,13 +81,16 @@ end : **Field**: `datasetId` +{{< note >}} -{{% inspec_filter_table %}} +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/dashboards/get-dashboards) for other properties available. ## Examples -**Loop through Power BI dashboard tiles by their IDs.** +### Loop through Power BI dashboard tiles by their IDs ```ruby azure_power_bi_dashboard_tiles.ids.each do |id| @@ -97,7 +100,7 @@ azure_power_bi_dashboard_tiles.ids.each do |id| end ``` -**Test to ensure all Power BI dashboard tiles that are in top left corner.** +### Test to ensure all Power BI dashboard tiles that are in the top left corner ```ruby describe azure_power_bi_dashboard_tiles.where(rowSpan: true) do @@ -107,7 +110,9 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists @@ -117,8 +122,12 @@ This InSpec audit resource has the following special matchers. For a full list o describe azure_power_bi_dashboard_tiles do it { should_not exist } end +``` -# Use should_not to test for an Azure Power BI dashboard tile that should not be in the resource group +### not_exists + +```ruby +# Use should_not to test for an Azure Power BI dashboard tile that should not be in the resource group. describe azure_power_bi_dashboard_tiles do it { should exist } @@ -127,4 +136,4 @@ end ## Azure Permissions -Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `dashboard.Read.All` role on the Azure Power BI Workspace you wish to test. \ No newline at end of file +Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `dashboard.Read.All` role on the Azure Power BI Workspace you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboards.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboards.md index 17f2863962..bf51b7ad9c 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboards.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dashboards.md @@ -14,11 +14,11 @@ Use the `azure_power_bi_dashboards` InSpec audit resource to test the properties ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -54,23 +54,26 @@ end : **Field**: `displayName` `embedUrls` -: List of all dashboard embed urls. +: List of all dashboard embed URLs. : **Field**: `embedUrl` `isReadOnly` -: List of all ReadOnly dashboards. +: List of all read-only dashboards. : **Field**: `isReadOnlies` +{{< note >}} -{{% inspec_filter_table %}} +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/dashboards/get-dashboards) for other properties available. ## Examples -**Loop throughPower BI Dashboards by their IDs.** +### Loop throughPower BI Dashboards by their IDs ```ruby azure_power_bi_dashboards.ids.each do |id| @@ -80,7 +83,7 @@ azure_power_bi_dashboards.ids.each do |id| end ``` -**Test to ensure all Power BI dashboards are ready only.** +### Test to ensure all Power BI dashboards are ready-only ```ruby describe azure_power_bi_dashboards.where(isReadOnly: true) do @@ -90,18 +93,20 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Power BI dashboards are present in the group +# Should not exist if no Power BI dashboards are present in the group. describe azure_power_bi_dashboards do it { should_not exist } end -# Should exist if the filter returns at least one Power BI dashboard in the group +# Should exist if the filter returns at least one Power BI dashboard in the group. describe azure_power_bi_dashboards do it { should exist } @@ -110,4 +115,4 @@ end ## Azure Permissions -Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `dashboard.Read.All` role on the Azure Power BI Workspace you wish to test. \ No newline at end of file +Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `dashboard.Read.All` role on the Azure Power BI Workspace you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataflow.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataflow.md index 86f8b8df45..42d84d5afc 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataflow.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataflow.md @@ -14,11 +14,11 @@ Use the `azure_power_bi_dataflow` InSpec audit resource to test the properties o ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -44,7 +44,6 @@ end : The workspace ID. - ## Properties `name` @@ -59,14 +58,13 @@ end `modelUrl` : A URL to the dataflow definition file (model.json). - For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/dataflows/get-dataflows) for other properties available. ## Examples -**Test that the Power BI dataflow name exists.** +### Test that the Power BI dataflow name exists ```ruby describe azure_power_bi_dataflow(group_id: 'GROUP_ID', name: 'DATAFLOW_ID') do @@ -89,7 +87,9 @@ describe azure_power_bi_dataflow(group_id: 'GROUP_ID', name: 'DATAFLOW_ID') do end ``` -Use `should_not` to test the entity does not exist. +### not_exists + +Use `should_not` to test if the entity does not exist. ```ruby describe azure_power_bi_dataflow(group_id: 'GROUP_ID', name: 'DATAFLOW_ID') do @@ -99,4 +99,4 @@ end ## Azure Permissions -Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `Dataflow.Read.All` role on the Azure Power BI dataflow you wish to test. \ No newline at end of file +Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `Dataflow.Read.All` role on the Azure Power BI dataflow you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataflow_storage_accounts.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataflow_storage_accounts.md new file mode 100644 index 0000000000..568029b8cc --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataflow_storage_accounts.md @@ -0,0 +1,100 @@ ++++ +title = "azure_power_bi_dataflow_storage_accounts Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_power_bi_dataflow_storage_accounts" +identifier = "inspec/resources/azure/azure_power_bi_dataflow_storage_accounts Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_power_bi_dataflow_storage_accounts` InSpec audit resource to test the properties related to all Azure Power BI dataflow storage accounts. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_power_bi_dataflow_storage_accounts` resource block returns all Azure Power BI dataflow storage accounts. + +```ruby +describe azure_power_bi_dataflow_storage_accounts do + #... +end +``` + +## Parameters + +This resource does not require any parameters. + +## Properties + +`ids` +: List of all Power BI dataflow storage account IDs. + +: **Field**: `id` + +`names` +: List of all the dataflow storage account names. + +: **Field**: `name` + +`isEnableds` +: List of the flags that indicates if workspaces can be assigned to the storage accounts. + +: **Field**: `isEnabled` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/dataflow-storage-accounts/get-dataflow-storage-accounts) for other properties available. + +## Examples + +### Test that the Power BI dataflow storage account is enabled + +```ruby +describe azure_power_bi_dataflow_storage_accounts.where(isEnabled: true) do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no Power BI dataflow storage account is present. + +describe azure_power_bi_dataflow_storage_accounts do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Power BI dataflow storage account. + +describe azure_power_bi_dataflow_storage_accounts do + it { should exist } +end +``` + +## Azure Permissions + +Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `StorageAccount.Read.All` role on the Azure Power BI dataflow storage Account you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataflows.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataflows.md index b5f1d1fbe0..5f64f92618 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataflows.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataflows.md @@ -14,11 +14,11 @@ Use the `azure_power_bi_dataflows` InSpec audit resource to test the properties ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -35,23 +35,41 @@ end `group_id` : The Workspace ID. - ## Properties -|Property | Description | Filter Criteria* | -|---------------------------|------------------------------------------------------------------------|------------------| -| objectIds | List of all Power BI dataflow IDs. | `objectId` | -| names | List of all the Power BI dataflow names. | `name` | -| descriptions | List of all the Power BI dataflow descriptions. | `description` | -| modelUrls | List of all URLs to the dataflow definition file | `modelUrl` | | `modelUrl` | +`objectIds` + +: List of all Power BI dataflow IDs. + +: **Field**: `objectId` + +`names` + +: List of all the Power BI dataflow names. + +: **Field**: `name` + +`descriptions` + +: List of all the Power BI dataflow descriptions. + +: **Field**: `descriptions` +`modelUrls` -* For information on how to use filter criteria on plural resources refer to [FilterTable usage](https://github.com/inspec/inspec/blob/master/dev-docs/filtertable-usage.md). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/dataflows/get-dataflows) for other properties available. +: List of all URLs to the dataflow definition file + +: **Field**: `modelUrl` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test to ensure Power BI Dataflow for Finance exists.** +### Test to ensure Power BI Dataflow for Finance exists ```ruby describe azure_power_bi_dataflows(group_id: 'GROUP_ID').where(name: 'DATAFLOW_NAME') do @@ -61,17 +79,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Power BI dataflows are present +# Should not exist if no Power BI dataflows are present. describe azure_power_bi_dataflows(group_id: 'GROUP_ID') do it { should_not exist } end -# Should exist if the filter returns at least one Power BI dataflows +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Power BI dataflows. describe azure_power_bi_dataflows(group_id: 'GROUP_ID') do it { should exist } @@ -80,4 +105,4 @@ end ## Azure Permissions -Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `Dataflow.Read.All` role on the Azure Power BI Dataflow you wish to test. \ No newline at end of file +Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `Dataflow.Read.All` role on the Azure Power BI Dataflow you wish to test. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataset.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataset.md index b7a9b12fd2..bfe33ec8d7 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataset.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataset.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_power_bi_dataset Resource" parent = "inspec/resources/azure" +++ -Use the `azure_power_bi_dataset` InSpec audit resource to test the properties related to Azure Power BI dataset. +Use the `azure_power_bi_dataset` InSpec audit resource to test the properties related to an Azure Power BI dataset. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -37,11 +37,9 @@ end ## Parameters `name` _(required)_ - : The dataset ID. `group_id` _(optional)_ - : The workspace ID. ## Properties @@ -67,14 +65,13 @@ end `isOnPremGatewayRequired` : dataset requires an On-premises Data Gateway. - For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/datasets/get-dataset) for other properties available. ## Examples -**Test that the Power BI dataset requires an on-prem gateway.** +### Test that the Power BI dataset requires an on-prem gateway ```ruby describe azure_power_bi_dataset(name: 'DATASET_ID') do @@ -90,11 +87,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If the Power BI dataset is found, it will exist +# If the Power BI dataset is found, it will exist. + describe azure_power_bi_dataset(name: 'DATASET_ID') do it { should exist } end -# if the Power BI dataset is not found, it will not exist +``` + +### not_exists + +```ruby +# if the Power BI dataset is not found, it will not exist. + describe azure_power_bi_dataset(name: 'DATASET_ID') do it { should_not exist } end diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataset_datasources.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataset_datasources.md index 3aed7b5580..ae274d2b31 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataset_datasources.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_dataset_datasources.md @@ -14,11 +14,11 @@ Use the `azure_power_bi_dataset_datasources` Chef InSpec audit resource to test ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -33,11 +33,9 @@ end ## Parameters `dataset_id` _(required)_ - : The dataset ID. `group_id` _(optional)_ - : The workspace ID. ## Properties @@ -62,13 +60,17 @@ end : **Field**: `connectionDetails` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/datasets/get-datasources) for other properties available. ## Examples -**Verify that a Power BI dataset data source for a server exists.** +### Verify that a Power BI dataset data source for a server exists ```ruby describe azure_power_bi_dataset_datasources(dataset_id: 'DATASET_ID').where{ connectionDetails[:server] == 'CONNECTION_SERVER' } do @@ -82,7 +84,7 @@ This Chef InSpec audit resource has the following special matchers. For a full l ### exists -**Verify that a Power BI dataset data source is not present.** +Verify that a Power BI dataset data source is not present. ```ruby describe azure_power_bi_dataset_datasources(dataset_id: 'DATASET_ID') do @@ -90,9 +92,11 @@ describe azure_power_bi_dataset_datasources(dataset_id: 'DATASET_ID') do end ``` -**Verify that at least one Power BI dataset data source exists.** +### not_exists -``` +Verify that at least one Power BI dataset data source exists. + +``` ruby describe azure_power_bi_dataset_datasources(dataset_id: 'DATASET_ID') do it { should exist } end diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_datasets.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_datasets.md index ae214601ce..421854e83d 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_datasets.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_datasets.md @@ -14,11 +14,11 @@ Use the `azure_power_bi_datasets` InSpec audit resource to test the properties o ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -33,7 +33,6 @@ end ## Parameters `group_id` _(optional)_ - : The workspace ID. ## Properties @@ -49,12 +48,12 @@ end : **Field**: `name` `addRowsAPIEnableds` -: List of boolean flags which describes whether the dataset allows adding new rows. +: List of boolean flags which describe whether the dataset allows adding new rows. : **Field**: `addRowsAPIEnabled` `isRefreshables` -: List of boolean flags that represent refreshable parameter of datasets. +: List of boolean flags that represent refreshable parameters of datasets. : **Field**: `isRefreshable` @@ -64,22 +63,26 @@ end : **Field**: `isEffectiveIdentityRequired` `isEffectiveIdentityRolesRequireds` -: List of boolean flags that describes whether RLS is defined inside the PBIX file. +: List of boolean flags that describe whether `RLS` is defined inside the `PBIX` file. : **Field**: `isEffectiveIdentityRolesRequired` `isOnPremGatewayRequireds` -: List of boolean flags that describes whether dataset requires an On-premises Data Gateway. +: List of boolean flags that describe whether the dataset requires an On-premises Data Gateway. : **Field**: `isOnPremGatewayRequired` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/datasets/get-datasets) for other properties available. ## Examples -**Test to ensure Power BI dataset is refreshable.** +### Test to ensure the Power BI dataset is refreshable ```ruby describe azure_power_bi_datasets.where(isRefreshable: true) do @@ -89,17 +92,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Power BI datasets are present +# Should not exist if no Power BI datasets are present. describe azure_power_bi_datasets do it { should_not exist } end -# Should exist if the filter returns at least one Power BI datasets +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Power BI dataset. describe azure_power_bi_datasets do it { should exist } diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_embedded_capacities.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_embedded_capacities.md new file mode 100644 index 0000000000..06b69a5903 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_embedded_capacities.md @@ -0,0 +1,149 @@ ++++ +title = "azure_power_bi_embedded_capacities Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_power_bi_embedded_capacities" +identifier = "inspec/resources/azure/azure_power_bi_embedded_capacities Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_power_bi_embedded_capacities` InSpec audit resource to test the properties related to all Azure Power BI Embedded Capacities within a project. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_power_bi_embedded_capacities` resource block returns all Azure Power BI Embedded Capacities within a project. + +```ruby +describe azure_power_bi_embedded_capacities do + #... +end +``` + +## Parameters + +`account_name` +: The Azure Storage account name. + +`dns_suffix` +: The DNS suffix for the Azure Data Lake Storage endpoint. + +The following parameters are optional,`account_name` and `dns_suffix`. + +## Properties + +`ids` +: A list of Power BI dedicated resources. + +: **Field**: `id` + +`names` +: The names of all the Power BI dedicated resources. + +: **Field**: `name` + +`locations` +: A location list of all the Power BI dedicated resources. + +: **Field**: `location` + +`modes` +: A list of all the capacity modes. + +: **Field**: `mode` + +`provisioningStates` +: A list of all provisioning states. + +: **Field**: `provisioningState` + +`states` +: The current state of all Power BI dedicated resources. + +: **Field**: `state` + +`sku_names` +: The SKU name of the Power BI dedicated resource. + +: **Field**: `sku_name` + +`sku_tiers` +: The SKU tier of the Power BI dedicated resource. + +: **Field**: `sku_tier` + +`sku_capacities` +: The SKU capacities of the Power BI dedicated resource. + +: **Field**: `sku_capacity` + +`administration_members` +: A collection of dedicated capacity administrators. + +: **Field**: `administration_members` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Loop through Power BI Embedded Capacities by their names + +```ruby +azure_power_bi_embedded_capacities.names.each do |name| + describe azure_power_bi_embedded_capacity(resource_group: 'RESOURCE_GROUP', name: name) do + it { should exist } + end +end +``` + +### Test to ensure Power BI Embedded Capacities where `sku_capacities` greater than 1 + +```ruby +describe azure_power_bi_embedded_capacities.where(sku_capacity > 1 ) do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should exist if the filter returns at least one Migrate Assessment in the project and the resource group. + +describe azure_power_bi_embedded_capacities do + it { should exist } +end +``` + +### not_exists + +```ruby +# Should not exist if no Power BI Embedded Capacities are present in the project and the resource group. + +describe azure_power_bi_embedded_capacities do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_embedded_capacity.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_embedded_capacity.md new file mode 100644 index 0000000000..5a67608d35 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_embedded_capacity.md @@ -0,0 +1,120 @@ ++++ +title = "azure_power_bi_embedded_capacity Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_power_bi_embedded_capacity" +identifier = "inspec/resources/azure/azure_power_bi_embedded_capacity Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_power_bi_embedded_capacity` InSpec audit resource to test the properties related to an Azure Power BI Embedded Capacity. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +The `name` and `resource_group` are required parameters. + +```ruby +describe azure_power_bi_embedded_capacity(resource_group: 'RESOURCE_GROUP', name: 'POWER_BI_EMBEDDED') do + it { should exist } +end +``` + +```ruby +describe azure_power_bi_embedded_capacity(resource_group: 'RESOURCE_GROUP', name: 'POWER_BI_EMBEDDED') do + it { should exist } +end +``` + +## Parameters + +`name` +: Name of the Power BI Embedded Capacity to test. + +`resource_group` +: Azure Resource Group. + +The parameter set for a valid query that should be provided is `name` and `account_name`. + +## Properties + +`id` +: An identifier that represents the Power BI dedicated resource. + +`location` +: Location of the Power BI dedicated resource. + +`name` +: The name of the Power BI dedicated resource. + +`properties.administration` +: A collection of dedicated capacity administrators. + +`properties.mode` +: The capacity mode. + +`properties.state` +: The current state of Power BI dedicated resource. The state is to indicate more states outside of resource provisioning. + +`sku` +: The SKU of the Power BI dedicated resource. + +`tags` +: Key-value pairs of additional resource provisioning properties. + +`type` +: The type of the Power BI dedicated resource. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi-embedded/capacities/get-details) for other properties available. + +## Examples + +### Test that the Power BI Embedded Capacity + +```ruby +describe azure_power_bi_embedded_capacity(resource_group: 'RESOURCE_GROUP', name: 'POWER_BI_EMBEDDED') do + its('count') { should eq 1.0 } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If the Power BI Embedded Capacity is found, it will exist. + +describe azure_power_bi_embedded_capacity(resource_group: 'RESOURCE_GROUP', name: 'POWER_BI_EMBEDDED') do + it { should exist } +end +``` + +### not_exists + +```ruby +# if the Power BI Embedded Capacity is not found, it will not exist. + +describe azure_power_bi_embedded_capacity(resource_group: 'RESOURCE_GROUP', name: 'POWER_BI_EMBEDDED') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_gateway.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_gateway.md index 48771686d9..183b3fe4cf 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_gateway.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_gateway.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_power_bi_gateway Resource" parent = "inspec/resources/azure" +++ -Use the `azure_power_bi_gateway` InSpec audit resource to test the properties related to Azure Power BI gateway. +Use the `azure_power_bi_gateway` InSpec audit resource to test the properties related to an Azure Power BI gateway. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`gateway_id` is a required parameter. +The `gateway_id` is a required parameter. ```ruby describe azure_power_bi_gateway(gateway_id: 'GATEWAY_ID') do @@ -33,7 +33,6 @@ end ## Parameters `gateway_id` _(required)_ - : The gateway ID. ## Properties @@ -59,7 +58,7 @@ Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/p ## Examples -**Test that the Power BI gateway's exponent is `AQAB`.** +### Test that the Power BI gateway's exponent is 'AQAB' ```ruby describe azure_power_bi_gateway(gateway_id: 'GATEWAY_ID') do @@ -74,11 +73,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If the Azure Power BI gateway is found, it will exist +# If the Azure Power BI gateway is found, it will exist. + describe azure_power_bi_gateway(gateway_id: 'GATEWAY_ID') do it { should exist } end -# if the Azure Power BI gateway is not found, it will not exist +``` + +### not_exists + +```ruby +# if the Azure Power BI gateway is not found, it will not exist. + describe azure_power_bi_gateway(gateway_id: 'GATEWAY_ID') do it { should_not exist } end diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_gateways.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_gateways.md index d0451fcc86..b1bff5720a 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_gateways.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_power_bi_gateways.md @@ -14,11 +14,11 @@ Use the `azure_power_bi_gateways` InSpec audit resource to test the properties r ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -30,8 +30,6 @@ describe azure_power_bi_gateways do end ``` -## Parameters - ## Properties `ids` @@ -59,13 +57,16 @@ end : **Field**: `modulus` +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} -{{% inspec_filter_table %}} -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/Gateways/get-Gateways) for other available properties. +{{< /note>}} +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/power-bi/Gateways/get-Gateways) for other available properties. ## Examples -**Loop through Power BI gateways by their IDs.** +### Loop through Power BI gateways by their IDs ```ruby azure_power_bi_gateways.ids.each do |id| @@ -75,7 +76,7 @@ azure_power_bi_gateways.ids.each do |id| end ``` -**Test to ensure all Power BI gateways exponent is `AQAB`.** +### Test to ensure all Power BI gateways exponent is 'AQAB' ```ruby describe azure_power_bi_gateways.where(exponent: 'AQAB') do @@ -85,17 +86,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Power BI gateways are present +# Should not exist if no Power BI gateways are present. describe azure_power_bi_gateways do it { should_not exist } end -# Should exist if the filter returns at least one Power BI gateways +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Power BI gateway. describe azure_power_bi_gateways do it { should exist } diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_public_ip.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_public_ip.md index ed1ad472be..d51be39c4f 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_public_ip.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_public_ip.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_public_ip Resource" parent = "inspec/resources/azure" +++ -Use the `azure_public_ip` InSpec audit resource to test properties of an Azure Public IP address. +Use the `azure_public_ip` InSpec audit resource to test the properties of an Azure Public IP address. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_public_ip` resource block identifies a public IP address by `name` and `resource_group` or the `resource_id`. +An `azure_public_ip` resource block identifies a public IP address by `name` and `resource_group`, or the `resource_id`. + ```ruby -describe azure_public_ip(resource_group: 'example', name: 'addressName') do +describe azure_public_ip(resource_group: 'RESOURCE_GROUP', name: 'ADDRESS_NAME') do it { should exist } end ``` + ```ruby describe azure_public_ip(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}') do it { should exist } @@ -37,15 +39,16 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `resourceGroupName`. +: Azure resource group where the targeted resource resides. `name` -: The unique name of the public IP address. `publicIpAddressName`. +: The unique name of the public IP address. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` @@ -54,26 +57,27 @@ Either one of the parameter sets can be provided for a valid query: `properties.ipAddress` : The IP address associated with the public IP address resource. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/publicipaddresses/get#publicipaddress) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/publicipaddresses/get#publicipaddress) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test the IP Address of a Public IP Resource.** +### Test the IP Address of a Public IP Resource ```ruby -describe azure_public_ip(resource_group: 'example', name: 'publicIpAddressName') do +describe azure_public_ip(resource_group: 'RESOURCE_GROUP', name: 'ADDRESS_NAME') do its('properties.ipAddress') { should cmp '51.224.11.75' } end -``` +``` + ```ruby describe azure_public_ip(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}') do its('properties.ipAddress') { should cmp '51.224.11.75' } end -``` -See [integration tests](../../test/integration/verify/controls/azurerm_public_ip.rb) for more examples. +``` + +See [integration tests](https://github.com/inspec/inspec-azure/blob/main/test/integration/verify/controls/azure_public_ip.rb) for more examples. ## Matchers @@ -82,19 +86,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect the resource to always exist +# If we expect the resource to always exist. -describe azure_public_ip(resource_group: 'example', name: 'publicIpAddressName') do +describe azure_public_ip(resource_group: 'RESOURCE_GROUP', name: 'ADDRESS_NAME') do it { should exist } end +``` -# If we expect the resource not to exist +### not_exists + +```ruby +# If we expect the resource not to exist. -describe azure_public_ip(resource_group: 'example', name: 'publicIpAddressName') do +describe azure_public_ip(resource_group: 'RESOURCE_GROUP', name: 'ADDRESS_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_redis_cache.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_redis_cache.md index 86d8e7071a..928b5d5ce6 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_redis_cache.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_redis_cache.md @@ -14,11 +14,11 @@ Use the `azure_redis_cache` InSpec audit resource to test the properties related ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -44,14 +44,12 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` : Name of the Azure Redis cache to test. -The parameter set should be provided for a valid query: - -- `resource_group` and `name` +The parameter set should be provided for a valid query are `resource_group` and `name`. ## Properties @@ -59,10 +57,10 @@ The parameter set should be provided for a valid query: : Resource ID. `name` -: Redis Cache Name. +: Redis cache name. `location` -: Redis Cache Location. +: Redis cache location. `type` : Resource type. @@ -71,13 +69,13 @@ The parameter set should be provided for a valid query: : Resource tags. `properties.sku.name` -: The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium). +: The type of Redis cache to deploy. Valid values are `Basic`, `Standard`, and `Premium`. `properties.sku.family` -: The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). +: The SKU family to use. Valid values are `C` and `P` (C = Basic/Standard, P = Premium). `properties.sku.capacity` -: The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4). +: The size of the Redis cache to deploy. Valid values are `C` (Basic/Standard; family: 0, 1, 2, 3, 4, 5, 6) and `P` (Premium, family: 1, 2, 3, 4). `properties.provisioningState` : The resource's provisioning state. @@ -88,14 +86,14 @@ The parameter set should be provided for a valid query: `properties.enableNonSslPort` : Specifies whether the non-SSL Redis server port (6379) is enabled. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/redis/redis/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test that the Redis instance's provisioning status equals 'Succeeded'.** +### Test that the Redis instance's provisioning status equals 'Succeeded' ```ruby describe azure_redis_cache(resource_group: 'RESOURCE_GROUP', name: 'REDIS_CACHE_NAME') do @@ -103,9 +101,9 @@ describe azure_redis_cache(resource_group: 'RESOURCE_GROUP', name: 'REDIS_CACHE_ end ``` -**Test that the Redis instance Skuname equals 'Standard'.** +### Test that the Redis instance Skuname equals 'Standard' -**Skuname** is the Redis cache to deploy. Valid values are `Basic`, `Standard`, `Premium`. +**Skuname** is the Redis cache to deploy. Valid values are `Basic`, `Standard`, and `Premium`. ```ruby describe azure_redis_cache(resource_group: 'RESOURCE_GROUP', name: 'REDIS_CACHE_NAME') do @@ -120,13 +118,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a redis cache is found it will exist +# If a Redis cache is found, it will exist. describe azure_redis_cache(resource_group: 'RESOURCE_GROUP', name: 'REDIS_CACHE_NAME') do it { should exist } end +``` + +### not_exists + +```ruby -# Redis Caches that aren't found will not exist +# Redis Caches that aren't found, will not exist. describe azure_redis_cache(resource_group: 'RESOURCE_GROUP', name: 'REDIS_CACHE_NAME') do it { should_not exist } end @@ -134,7 +137,7 @@ end ### be_enabled_non_ssl_port -Ensure that the Redis Cache supports non-SSL ports. +Ensure that the Redis cache supports non-SSL ports. ```ruby describe azure_redis_cache(resource_group: 'RESOURCE_GROUP', name: 'REDIS_CACHE_NAME') do @@ -144,4 +147,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_redis_caches.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_redis_caches.md index 90c123dae5..904df25fdb 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_redis_caches.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_redis_caches.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_redis_caches Resource" parent = "inspec/resources/azure" +++ -Use the `azure_redis_caches` InSpec audit resource to test properties of multiple Azure Redis caches in a resource group or in an entire subscription. +Use the `azure_redis_caches` InSpec audit resource to test the properties of multiple Azure Redis caches in a resource group or an entire subscription. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_redis_caches` resource block returns all Azure Redis caches within a Resource Group. +An `azure_redis_caches` resource block returns all Azure Redis caches within a resource group. ```ruby describe azure_redis_caches(resource_group: 'RESOURCE_GROUP') do @@ -40,12 +40,10 @@ end ## Parameters -The parameter should be provided for a valid query - -- `resource_group` +The parameter should be provided for a valid query is `resource_group`. `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. ## Properties @@ -55,7 +53,7 @@ The parameter should be provided for a valid query : **Field**: `id` `names` -: A list of name for all the Resource names. +: A list of name for all the resource names. : **Field**: `name` @@ -70,7 +68,7 @@ The parameter should be provided for a valid query : **Field**: `location` `properties` -: A list of properties all the resources. +: A list of properties for all the resources. : **Field**: `properties` @@ -100,17 +98,17 @@ The parameter should be provided for a valid query : **Field**: `instances_ssl_ports` `is_master_instance` -: A list of Redis instance is_master flag. +: A list of Redis instance `is_master` flag. : **Field**: `is_master_instance` `is_primary_instance` -: A list of Redis instance is_primary flag. +: A list of Redis instance `is_primary` flag. : **Field**: `is_primary_instance` `max_clients` -: A list of max clients in redis configuration. +: A list of max clients in Redis configuration. : **Field**: `max_clients` @@ -120,7 +118,7 @@ The parameter should be provided for a valid query : **Field**: `max_memory_reserved` `max_fragmentation_memory_reserves` -: A list of max fragmentation memory reserves in redis configuration. +: A list of max fragmentation memory reserves in Redis configuration. : **Field**: `max_fragmentation_memory_reserved` @@ -174,11 +172,15 @@ The parameter should be provided for a valid query : **Field**: `linked_servers` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through Redis Caches by their names.** +### Loop through Redis Caches by their names ```ruby azure_redis_caches(resource_group: 'RESOURCE_GROUP').names.each do |name| @@ -188,7 +190,7 @@ azure_redis_caches(resource_group: 'RESOURCE_GROUP').names.each do |name| end ``` -**Test that there is Redis cache with a specific string in its names using client-side filtering.** +### Test that there is Redis cache with a specific string in its names using client-side filtering ```ruby describe azure_redis_caches(resource_group: 'RESOURCE_GROUP').where { name.include?('spec-client') } do @@ -198,18 +200,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no redis caches are in the resource group +# Should not exist if no Redis caches are in the resource group. describe azure_redis_caches(resource_group: 'RESOURCE_GROUP') do it { should_not exist } end +``` + +### not_exists -# Should exist if the filter returns at least one redis cache +```ruby +# Should exist if the filter returns at least one Redis cache. describe azure_redis_caches(resource_group: 'RESOURCE_GROUP') do it { should exist } @@ -218,4 +226,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_group.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_group.md index 3a84c2f234..2e3eeecede 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_group.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_group.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_resource_group Resource" parent = "inspec/resources/azure" +++ -Use the `azure_resource_group` InSpec audit resource to test properties and configuration of an Azure resource group. +Use the `azure_resource_group` InSpec audit resource to test the properties and configuration of an Azure resource group. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`name` or the `resource_id` must be given as a parameter. +`name` or the `resource_id` are required parameters. + ```ruby -describe azure_resource_group(name: 'my_resource_group') do +describe azure_resource_group(name: 'RESOURCE_GROUP') do it { should exist } end ``` + ```ruby describe azure_resource_group(resource_id: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}') do it { should exist } @@ -37,12 +39,13 @@ end ## Parameters `name` -: Name of the resource group. `resourceGroupName`. +: Name of the resource group. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `name` @@ -51,55 +54,63 @@ Either one of the parameter sets can be provided for a valid query: `properties.provisioningState` : The provisioning state. `Succeeded`. -For properties applicable to all resources, such as `type`, `name`, `id`, `location`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, `location`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/resources/policydefinitions/get#policydefinition) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/policy/policy-definitions/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test a Resource Group Location.** +### Test a resource group location ```ruby -describe azure_resource_group(name: 'my_resource_group') do +describe azure_resource_group(name: 'RESOURCE_GROUP') do its('location') { should cmp 'eastus' } end ``` -**Test a Resource Group Provisioning State.** + +### Test a resource group provisioning state ```ruby -describe azure_resource_group(name: 'my_resource_group') do +describe azure_resource_group(name: 'RESOURCE_GROUP') do its('properties.provisioningState') { should cmp 'Succeeded' } end -``` -**Test a Resource Group Tags.** +``` + +### Test a resource group tags ```ruby -describe azure_resource_group(name: 'my_resource_group') do +describe azure_resource_group(name: 'RESOURCE_GROUP') do its('tags') { should include(:owner) } its('tags') { should include(owner: 'InSpec') } end -``` +``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# If we expect a resource group to always exist +# If we expect a resource group to always exist. -describe azure_resource_group(name: 'my_resource_group') do +describe azure_resource_group(name: 'RESOURCE_GROUP') do it { should exist } end -# If we expect a resource group to never exist +``` + +### not_exists + +```ruby +# If we expect a resource group to never exist. -describe azure_resource_group(name: 'my_resource_group') do +describe azure_resource_group(name: 'RESOURCE_GROUP') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_groups.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_groups.md index 1fd6fc4fd6..4913ce56bb 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_groups.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_groups.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_resource_groups Resource" parent = "inspec/resources/azure" +++ -Use the `azure_resource_groups` InSpec audit resource to test properties and configuration of multiple Azure resource groups. +Use the `azure_resource_groups` InSpec audit resource to test the properties and configuration of multiple Azure resource groups. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -37,7 +37,7 @@ This resource does not require any parameters. ## Properties `ids` -: A list of the unique resource group ids. +: A list of the unique resource group IDs. : **Field**: `id` @@ -56,11 +56,15 @@ This resource does not require any parameters. : **Field**: `location` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check if a specific resource group is present.** +### Check if a specific resource group is present ```ruby describe azure_resource_groups do @@ -68,7 +72,7 @@ describe azure_resource_groups do end ``` -**Filters the Results to Include Only Those Resource Groups which Include the Given Name.** +### Filters the results to include only those resource groups that have the specified name ```ruby describe azure_resource_groups.where{ name.include?('my-resource-group') } do @@ -76,7 +80,7 @@ describe azure_resource_groups.where{ name.include?('my-resource-group') } do end ``` -**Filters the Results to Include Only The Resource Groups that Have Certain Tag.** +### Filters the results to include only the resource groups that have specified tag ```ruby describe azure_resource_groups.where{ tags.has_key?('owner') && tags['owner'] == "InSpec" } do @@ -87,11 +91,13 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. ```ruby describe azure_resource_groups do @@ -101,4 +107,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_availability_status.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_availability_status.md index 218caccfe4..01d6dd32b3 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_availability_status.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_availability_status.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_resource_health_availability_status R parent = "inspec/resources/azure" +++ -Use the `azure_resource_health_availability_status` InSpec audit resource to test properties related to a Azure Resource Health availability status. +Use the `azure_resource_health_availability_status` InSpec audit resource to test the properties related to an Azure Resource Health availability status. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group`, `resource_type` and `name` are required parameters. +`resource_group`, `resource_type`, and `name` are required parameters. ```ruby describe azure_resource_health_availability_status(resource_group: 'AZURE_RESOURCE_GROUP', resource_type: 'AZURE_RESOURCE_TYPE', name: 'RESOURCE_NAME') do @@ -41,18 +41,17 @@ end : Name of the Azure resource to test. `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `resource_type` : Azure resource type of the targeted resource. -The parameter set should be provided for a valid query: -- `resource_group`, `resource_type` and `name` +The parameter set should be provided for a valid query are `resource_group`, `resource_type`, and `name`. ## Properties `id` -: Azure Resource Manager Identity for the availabilityStatuses resource. +: Azure Resource Manager Identity for the `availabilityStatuses` resource. `name` : current. @@ -66,14 +65,13 @@ The parameter set should be provided for a valid query: `properties` : Properties of availability state. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/resourcehealth/availability-statuses/get-by-resource) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/resourcehealth/availability-statuses/get-by-resource) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test availability status of a resource.** +### Test availability status of a resource ```ruby describe azure_resource_health_availability_status(resource_group: 'AZURE_RESOURCE_GROUP', resource_type: 'AZURE_RESOURCE_TYPE', name: 'RESOURCE_NAME') do @@ -81,7 +79,7 @@ describe azure_resource_health_availability_status(resource_group: 'AZURE_RESOUR end ``` -**Test the chronicity type of a resource.** +### Test the chronicity type of a resource ```ruby describe azure_resource_health_availability_status(resource_group: 'AZURE_RESOURCE_GROUP', resource_type: 'AZURE_RESOURCE_TYPE', name: 'RESOURCE_NAME') do @@ -96,7 +94,7 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a resource status is found it will exist +# If a resource status is found, it will exist. describe azure_resource_health_availability_status(resource_group: 'AZURE_RESOURCE_GROUP', resource_type: 'AZURE_RESOURCE_TYPE', name: 'RESOURCE_NAME') do it { should exist } @@ -105,4 +103,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_availability_statuses.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_availability_statuses.md index baf51ebebd..bc96cdc62a 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_availability_statuses.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_availability_statuses.md @@ -10,19 +10,20 @@ identifier = "inspec/resources/azure/azure_resource_health_availability_statuses parent = "inspec/resources/azure" +++ -Use the `azure_resource_health_availability_statuses` InSpec audit resource to test properties related to all Azure Availability Statuses for the subscription. +Use the `azure_resource_health_availability_statuses` InSpec audit resource to test the properties related to all Azure Availability Statuses for the subscription. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_resource_health_availability_statuses` resource block returns all Azure Availability Statuses within a Subscription. +An `azure_resource_health_availability_statuses` resource block returns all Azure Availability Statuses within a subscription. + ```ruby describe azure_resource_health_availability_statuses do #... @@ -36,7 +37,7 @@ This resource does not require any parameters. ## Properties `ids` -: A list of the Azure Resource Manager Identity for the availabilityStatuses resources. +: A list of the Azure Resource Manager Identity for the `availabilityStatuses` resources. : **Field**: `id` @@ -46,7 +47,7 @@ This resource does not require any parameters. : **Field**: `name` `types` -: Microsoft.ResourceHealth/AvailabilityStatuses. +: `Microsoft.ResourceHealth/AvailabilityStatuses`. : **Field**: `type` @@ -60,11 +61,15 @@ This resource does not require any parameters. : **Field**: `location` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through availability statuses by resource ID.** +### Loop through availability statuses by resource ID ```ruby azure_resource_health_availability_statuses.ids.each do |id| @@ -74,7 +79,7 @@ azure_resource_health_availability_statuses.ids.each do |id| end ``` -**Test that there are availability statuses that have an `Available` availability state.** +### Test that there are availability statuses that have an 'Available' availability state ```ruby describe azure_resource_health_availability_statuses.where{ properties.select{|prop| prop.availabilityState == 'Available' } } do @@ -84,18 +89,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no availability statuses are present in the subscription +# Should not exist if no availability statuses are present in the subscription. describe azure_resource_health_availability_statuses do it { should_not exist } end +``` + +### not_exists -# Should exist if the filter returns at least one availability status in the subscription +```ruby +# Should exist if the filter returns at least one availability status in the subscription. describe azure_resource_health_availability_statuses do it { should exist } @@ -104,4 +115,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_emerging_issue.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_emerging_issue.md index f01426003a..77e258a35f 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_emerging_issue.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_emerging_issue.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_resource_health_emerging_issue Resour parent = "inspec/resources/azure" +++ -Use the `azure_resource_health_emerging_issue` InSpec audit resource to test properties related to a Azure Resource Health Emerging issue. +Use the `azure_resource_health_emerging_issue` InSpec audit resource to test the properties related to an Azure Resource Health Emerging issue. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -42,7 +42,6 @@ end `name` : Name of the Azure Resource Health emerging issue to test. - ## Properties `id` @@ -52,10 +51,10 @@ end : The name of the resource. `type` -: The type of the resource. +: The type of resource. `properties.statusActiveEvents` -: The list of emerging issues of active event type. +: The list of emerging issues of the active event type. `properties.statusBanners` : The list of emerging issues of banner type. @@ -63,15 +62,14 @@ end `properties.refreshTimestamp` : Timestamp for when last time refreshed for ongoing emerging issue. - -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/resourcehealth/emerging-issues/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test that there are emerging issues with an active event type.** +### Test that there are emerging issues with an active event type ```ruby describe azure_resource_health_emerging_issue(name: 'default') do @@ -86,11 +84,16 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a emerging issue is found, it will exist +# If an emerging issue is found, it will exist. describe azure_resource_health_emerging_issue(name: 'default') do it { should exist } end -# If no emerging issues are found, it will not exist +``` + +### not_exists + +```ruby +# If no emerging issues are found, it will not exist. describe azure_resource_health_emerging_issue(name: 'default') do it { should_not exist } end @@ -98,4 +101,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_emerging_issues.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_emerging_issues.md index aca14d6bc0..8fd68f3281 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_emerging_issues.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_emerging_issues.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_resource_health_emerging_issues Resou parent = "inspec/resources/azure" +++ -Use the `azure_resource_health_emerging_issues` InSpec audit resource to test properties related to all Azure Resource Health Emerging Issues. +Use the `azure_resource_health_emerging_issues` InSpec audit resource to test the properties related to all Azure Resource Health Emerging issues. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_resource_health_emerging_issues` resource block returns all Azure Resource Health Emerging Issues. +An `azure_resource_health_emerging_issues` resource block returns all Azure Resource Health Emerging issues. ```ruby describe azure_resource_health_emerging_issues do @@ -52,18 +52,21 @@ This resource does not require any parameters. : **Field**: `type` `properties` -: A list of Properties all the resources. +: A list of Properties for all the resources. : **Field**: `properties` +{{< note >}} -{{% inspec_filter_table %}} +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} See [Azure's documentation](https://docs.microsoft.com/en-us/rest/api/resourcehealth/emerging-issues/get) for other available properties. ## Examples -**Test that there are emerging health issues that are of lower severity.** +### Test that there are emerging health issues that are of lower severity ```ruby describe azure_resource_health_emerging_issues.where{ properties.select{|prop| prop.statusActiveEvents.select{ |event| event.severity == 'Warning' } } } do @@ -73,17 +76,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no service health emerging issues are present +# Should not exist if no service health emerging issues are present. describe azure_resource_health_emerging_issues do it { should_not exist } end -# Should exist if the filter returns at least one service health emerging issues +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one service health emerging issue. describe azure_resource_health_emerging_issues do it { should exist } @@ -92,4 +102,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_events.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_events.md index 8e5f1e9f1a..6a60117f83 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_events.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_resource_health_events.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_resource_health_events Resource" parent = "inspec/resources/azure" +++ -Use the `azure_resource_health_events` InSpec audit resource to test properties related to all Azure Resource Health events for the subscription. +Use the `azure_resource_health_events` InSpec audit resource to test the properties related to all Azure Resource Health events for the subscription. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -40,14 +40,16 @@ end ## Parameters -**Note** +{{< note >}} To list all service health events in a subscription, do not provide any parameters. To list events for a particular resource, pass in all three parameters listed below. If one or more parameters are missing then all events in a subscription will be returned. +{{< /note >}} + `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `resource_type` : The name of the resource type. @@ -77,14 +79,17 @@ If one or more parameters are missing then all events in a subscription will be : **Field**: `properties` +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} -{{% inspec_filter_table %}} +{{< /note>}} See the [Azure documentation](https://docs.microsoft.com/en-us/rest/api/resourcehealth/events/list-by-single-resource) for other available properties. ## Examples -**Test that there are health events that have a service issue.** +### Test that there are health events that have a service issue ```ruby describe azure_resource_health_events.where{ properties.select{|prop| prop.eventType == 'ServiceIssue' } } do @@ -92,7 +97,7 @@ describe azure_resource_health_events.where{ properties.select{|prop| prop.event end ``` -**Test that there are health events for a particular resource.** +### Test that there are health events for a particular resource ```ruby describe azure_resource_health_events(resource_group: 'RESOURCE_GROUP', resource_type: 'RESOURCE_TYPE', resource_id: 'RESOURCE_ID') do @@ -102,18 +107,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no service health events are present in the subscription +# Should not exist if no service health events are present in the subscription. describe azure_resource_health_events do it { should_not exist } end +``` + +### not_exists -# Should exist if the filter returns at least one service health events in the subscription +```ruby +# Should exist if the filter returns at least one service health events in the subscription. describe azure_resource_health_events do it { should exist } @@ -122,4 +133,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_role_definition.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_role_definition.md index 46c48601b1..f8ad62ad17 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_role_definition.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_role_definition.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_role_definition Resource" parent = "inspec/resources/azure" +++ -Use the `azure_role_definition` InSpec audit resource to test properties and configuration of an Azure role definition. +Use the `azure_role_definition` InSpec audit resource to test the properties and configuration of an Azure role definition. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`name` or the `resource_id` must be given as a parameter. +`name` or the `resource_id` are required parameters. + ```ruby describe azure_role_definition(name: 'abcd-1234') do it { should exist } end ``` + ```ruby describe azure_role_definition(resource_id: '/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}') do it { should exist } @@ -37,12 +39,13 @@ end ## Parameters `name` -: Name of the role definition. `roleDefinitionName`. +: Name of the role definition. `resource_id` -: The unique resource ID. `/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `name` @@ -63,15 +66,13 @@ Either one of the parameter sets can be provided for a valid query: `permissions_not_allowed` : A list of denied actions within role definition permissions. +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). - -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/authorization/roledefinitions/get#roledefinition) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/authorization/roledefinitions/get#roledefinition) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test Allowed Permissions on a Role Definition.** +### Test allowed permissions on a role definition ```ruby describe azure_role_definition(name: 'policy-reader-only') @@ -84,17 +85,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# If we expect a resource to always exist +# If we expect a resource to always exist. describe azure_role_definition(name: 'abcd-1234') do it { should exist } end -# If we expect a resource to never exist +``` + +### not_exists + +```ruby +# If we expect a resource to never exist. describe azure_role_definition(name: 'abcd-1234') do it { should_not exist } @@ -103,4 +111,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_role_definitions.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_role_definitions.md index 06aa05804a..fc9661c133 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_role_definitions.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_role_definitions.md @@ -10,19 +10,20 @@ identifier = "inspec/resources/azure/azure_role_definitions Resource" parent = "inspec/resources/azure" +++ -Use the `azure_role_definitions` InSpec audit resource to test properties and configuration of multiple Azure role definitions. +Use the `azure_role_definitions` InSpec audit resource to test the properties and configuration of multiple Azure role definitions. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax An `azure_role_definitions` resource block returns all role definitions within a subscription. + ```ruby describe azure_role_definitions do it { should exist } @@ -36,7 +37,7 @@ This resource does not require any parameters. ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -60,48 +61,58 @@ This resource does not require any parameters. : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check a Specific Role Definition is Present.** +### Check a specific role definition is present ```ruby describe azure_role_definitions do its('names') { should include 'my-role' } end ``` -**Filter the Results to Include Only Those Role Definitions which Include the Given Name.** + +### Filter the results to include only those role definitions that have the specified name ```ruby describe azure_role_definitions.where{ name.include?('my-role') } do it { should exist } end ``` -**Filter the Results to Include Only The Built-in Role Definitions.** + +### Filter the results to include only the built-in role definitions ```ruby describe azure_role_definitions.where{ type == "BuiltInRole" } do it { should exist } its('count') { should be 15 } end -``` -**Filter the Results to Include Only the Role Definitions that Contain `Kubernetes` in the Role Name.** +``` + +### Filter the results to include only the role definitions that contain 'Kubernetes' in the role name ```ruby describe azure_role_definitions.where{ role_name.include?('Kubernetes') } do it { should exist } its('count') { should be 15 } end -``` +``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby describe azure_role_definitions do it { should exist } @@ -110,4 +121,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_security_center_policies.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_security_center_policies.md index d83fcedbd6..82bcdc211d 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_security_center_policies.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_security_center_policies.md @@ -10,19 +10,20 @@ identifier = "inspec/resources/azure/azure_security_center_policies Resource" parent = "inspec/resources/azure" +++ -Use the `azure_security_center_policies` InSpec audit resource to test properties and configuration of multiple Azure Polices. +Use the `azure_security_center_policies` InSpec audit resource to test the properties and configuration of multiple Azure Policies. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax An `azure_subscriptions` resource block returns all security policies for a subscription. + ```ruby describe azure_security_center_policies do it { should exist } @@ -36,7 +37,7 @@ This resource does not require any parameters. ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -50,40 +51,49 @@ This resource does not require any parameters. : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check If a Specific Policy is Present.** +### Check if a specific policy is present ```ruby describe azure_security_center_policies do its('names') { should include 'my-policy' } end ``` -**Filter the Results to Include Only Those Policies which Include a Given String in Their Names.** + +### Filter the results to include only those policies that have a specified string in their names ```ruby describe azure_security_center_policies.where{ name.include?('production') } do it { should exist } end ``` -**Filter the Results to Include Only Those Policies that the Log Collection is Enabled.** + +### Filter the results to include only those policies that the log collection is enabled ```ruby describe azure_security_center_policies.where{ properties[:logCollection] == 'On' } do it { should exist } its('count') { should eq 4 } end -``` +``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby describe azure_security_center_policies do it { should exist } @@ -92,4 +102,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_security_center_policy.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_security_center_policy.md index 726b00a60d..75af3a6da0 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_security_center_policy.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_security_center_policy.md @@ -10,19 +10,20 @@ identifier = "inspec/resources/azure/azure_security_center_policy Resource" parent = "inspec/resources/azure" +++ -Use the `azure_security_center_policy` InSpec audit resource to test properties and configuration of an Azure security policy. +Use the `azure_security_center_policy` InSpec audit resource to test the properties and configuration of an Azure security policy. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_security_center_policy` resource block will lookup the `default` policy unless `resource_group` and `name` or the `resource_id` parameter is given. +An `azure_security_center_policy` resource block will lookup the `default` policy unless `resource_group` and `name`, or the `resource_id` parameter is given. + ```ruby # The default security policy will be interrogated. @@ -30,11 +31,13 @@ describe azure_security_center_policy do its('name') { should cmp 'default' } end ``` + ```ruby -describe azure_security_center_policy(resource_group: 'inspec-resource-group-9', name: 'example_policy') do +describe azure_security_center_policy(resource_group: 'RESOURCE_GROUP', name: 'POLICY_NAME') do it { should exist } end ``` + ```ruby describe azure_security_center_policy(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.Security/policies/{policy-name}') do it { should exist } @@ -44,23 +47,24 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: Name of the security policy to test. `policy-name`. +: Name of the security policy to test. `resource_id` : The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.Security/policies/{policy-name}`. `default_policy_api_version*` -: The endpoint api version for the `default_policy` property. The latest version will be used unless provided. +: The endpoint API version for the `default_policy` property. The latest version will be used unless provided. `auto_provisioning_settings_api_version*` -: The endpoint api version for the `auto_provisioning_settings` property. The latest version will be used unless provided. +: The endpoint API version for the `auto_provisioning_settings` property. The latest version will be used unless provided. * It will be ignored unless the default policy is tested. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` - `name: 'default'`: This is for backward compatibility. It is advised not to pass any parameters if the default security policy is tested. @@ -119,62 +123,73 @@ Either one of the parameter sets can be provided for a valid query: : Contains the security contact phone number. `default_policy*` -: This is the default set of policies monitored by Azure Security Center. +: This is the default set of policies monitored by Azure security center. `auto_provisioning_settings*` : This is the default auto provisioning setting for the subscription. *Only applicable to the default security policy. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test If Log Collection is Enabled.** +### Test if log collection is enabled ```ruby describe azure_security_center_policy(resource_group: 'my-rg', name: 'my_policy') do its('log_collection') { should cmp 'On' } end ``` + **Test If Notifications are Enabled.** ```ruby -describe azure_security_center_policy(resource_group: 'my-rg', name: 'my_policy') do +describe azure_security_center_policy(resource_group: 'RESOURCE_GROUP', name: 'POLICY_NAME') do its('notifications_enabled') { should be true } end -``` -See [integration tests](../../test/integration/verify/controls/azurerm_security_center_policy.rb) for more examples. +``` + +See [integration tests](https://github.com/inspec/inspec-azure/blob/main/test/integration/verify/controls/azure_security_center_policy.rb) for more examples. ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### have_auto_provisioning_enabled Test if auto provisioning is enabled. This can be used via the default security policy only. + ```ruby describe azure_security_center_policy do it { should have_auto_provisioning_enabled } end ``` + ### exists ```ruby -# If we expect a resource to always exist +# If we expect a resource to always exist. -describe azure_security_center_policy(resource_group: 'my-rg', server_name: 'my_policy') do +describe azure_security_center_policy(resource_group: 'RESOURCE_GROUP', name: 'POLICY_NAME') do it { should exist } end -# If we expect a resource to never exist +``` + +### not_exists + +```ruby +# If we expect a resource to never exist. -describe azure_security_center_policy(resource_group: 'my-rg', server_name: 'my_policy') do +describe azure_security_center_policy(resource_group: 'RESOURCE_GROUP', name: 'POLICY_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_alert_rule_template.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_alert_rule_template.md deleted file mode 100644 index f958738e9a..0000000000 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_alert_rule_template.md +++ /dev/null @@ -1,128 +0,0 @@ -+++ -title = "azure_sentinel_alert_rule_template Resource" -platform = "azure" -draft = false -gh_repo = "inspec-azure" - -[menu.inspec] -title = "azure_sentinel_alert_rule_template" -identifier = "inspec/resources/azure/azure_sentinel_alert_rule_template Resource" -parent = "inspec/resources/azure" -+++ - -Use the `azure_sentinel_alert_rule_template` InSpec audit resource to test properties of an Azure Sentinel alert rule template. - -See the [`Azure alert rule templates documentation`](https://docs.microsoft.com/en-us/rest/api/securityinsights/alert-rule-templates/list) for additional information. - -## Azure REST API Version, Endpoint, and HTTP Client Parameters - -{{% inspec_azure_common_parameters %}} - -## Installation - -{{% inspec_azure_install %}} - -## Syntax - -`resource_group`, `alert_rule_template_id`, and `workspace_name` are required parameters. - -```ruby -describe azure_sentinel_alert_rule_template(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME', alert_rule_template_id: 'ALERT_RULE_TEMPLATE_ID') do - #... -end -``` - -## Parameters - -`resource_group` -: Azure resource group that the targeted resource resides in. - -`workspace_name` -: Name for the workspace_name that you want to create your Sentinel alert rule template in. - -`alert_rule_template_id` -: The Sentinel alert rule template name. - -All the parameter sets needs be provided for a valid query: - -- `resource_group` -- `workspace_name` -- `alert_rule_template_id` - -## Properties - -`name` -: Name of the Azure resource to test. - -`id` -: The Sentinel alert rule template type. - -`properties` -: The Properties of the Resource. - -`type` -: Azure resource type. - -`kind` -: The alert rule kind. - -`properties.severity` -: The severity for alerts created by this alert rule. - -`properties.status` -: The alert rule template status. - -`properties.triggerThreshold` -: The threshold triggers this alert rule. - -`properties.displayName` -: The display name for alert rule template. - -`properties.triggerOperator` -: The operation against the threshold that triggers alert rule. - -`properties.queryPeriod` -: The period (in ISO 8601 duration format) that this alert rule looks at. - -`properties.queryFrequency` -: The frequency (in ISO 8601 duration format) for this alert rule to run. - -## Examples - -**Test if properties match.** - - ```ruby -describe azure_sentinel_alert_rule_template(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME', alert_rule_template_id: 'ALERT_RULE_TEMPLATE_ID') do - its('name') { should eq 'RESOURCE_NAME' } - its('type') { should eq 'Microsoft.SecurityInsights/AlertRuleTemplates' } - its('kind') { should eq 'ALERT_RULE_KIND' } - its('properties.triggerThreshold') { should eq INTEGER } - its('properties.status') { should eq 'STATUS' } - its('properties.displayName') { should eq 'ALERT_RULE_DISPLAY_NAME' } - its('properties.triggerOperator') { should eq 'OPERATOR' } - its('properties.queryPeriod') { should eq 'PERIOD' } - its('properties.queryFrequency') { should eq 'FREQUENCY' } - its('properties.severity') { should eq 'ALERT_SEVERITY' } -end - ``` - - -**Test that a Sentinel alert rule template exists.** - -```ruby -describe azure_sentinel_alert_rule_template(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME', alert_rule_template_id: 'ALERT_RULE_TEMPLATE_ID') do - it { should exist } -end -``` - -**Test that a Sentinel alert rule template does not exist.** - -```ruby -describe azure_sentinel_alert_rule_template(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME', alert_rule_template_id: 'ALERT_RULE_TEMPLATE_ID') do - it { should_not exist } -end - ``` - -## Azure Permissions - -{{% azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_alert_rule_templates.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_alert_rule_templates.md deleted file mode 100644 index 1d0f71ca8f..0000000000 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_alert_rule_templates.md +++ /dev/null @@ -1,150 +0,0 @@ -+++ -title = "azure_sentinel_alert_rule_templates Resource" -platform = "azure" -draft = false -gh_repo = "inspec-azure" - -[menu.inspec] -title = "azure_sentinel_alert_rule_templates" -identifier = "inspec/resources/azure/azure_sentinel_alert_rule_templates Resource" -parent = "inspec/resources/azure" -+++ - -Use the `azure_sentinel_alert_rule_templates` InSpec audit resource to test properties related to alert rule templates for a resource group or the entire subscription. - -See the [`Azure alert rule templates documentation`](https://docs.microsoft.com/en-us/rest/api/securityinsights/alert-rule-templates/list) for additional information. - -## Azure Rest API Version, Endpoint, And HTTP Client Parameters - -This resource interacts with API versions supported by the resource provider. -The `api_version` can be defined as a resource parameter. -If not provided, the latest version will be used. -For more information, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md" >}}). - -Unless defined, `azure_cloud` global endpoint, and default values for the HTTP client will be used. -For more information, refer to the resource pack [README](https://github.com/inspec/inspec-azure/blob/main/README.md). - -## Installation - -{{% inspec_azure_install %}} - -## Syntax - -An `azure_sentinel_alert_rule_templates` resource block returns all Azure alert rule templates, either within a Resource Group (if provided), or within an entire Subscription. - -```ruby -describe azure_sentinel_alert_rule_templates(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME') do - #... -end -``` - -`resource_group` and `workspace_name` are required parameters. - - -## Parameters - -`resource_group` -: Azure resource group that the targeted resource resides in. - -`workspace_name` -: Azure workspace Name for which alert rule templates are being retrieved. - -## Properties - -`names` -: A list of the unique resource names. - -: **Field**: `name` - -`ids` -: A list of alert rule templates IDs . - -: **Field**: `id` - -`properties` -: A list of properties for the resource. - -: **Field**: `properties` - -`types` -: A list of types for each resource. - -: **Field**: `type` - -`severities` -: The severity for alerts created by this alert rule. - -: **Field**: `severity` - -`statuses` -: The status of the alert rule. - -: **Field**: `status` - -`triggerThresholds` -: The email of the user the incident is assigned to. - -: **Field**: `triggerThreshold` - -`displayNames` -: The user principal name of the user the incident is assigned to. - -: **Field**: `displayName` - -`triggerOperators` -: The name of the user the incident is assigned to. - -: **Field**: `triggerOperator` - -`queryPeriods` -: The List of period (in ISO 8601 duration format) that this alert rule looks at. - -: **Field**: `queryPeriod` - -`queryFrequencies` -: The List of frequency (in ISO 8601 duration format) for this alert rule to run. - -: **Field**: `queryFrequency` - -{{% inspec_filter_table %}} - -## Examples - -**Test if properties matches.** - -```ruby -describe azure_sentinel_alert_rule_templates(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME') do - its('names') { should include 'RESOURCE_NAME' } - its('types') { should include 'Microsoft.SecurityInsights/AlertRuleTemplates' } - its('kinds') { should include 'ALERT_RULE_KIND' } - its('triggerThresholds') { should include INTEGER } - its('statuses') { should include 'STATUS' } - its('severities') { should include 'ALERT_SEVERITY' } - its('queryFrequencies') { should include 'FREQUENCY' } - its('queryPeriods') { should include 'PERIOD' } - its('triggerOperators') { should include 'OPERATOR' } - its('displayNames') { should include 'ALERT_RULE_DISPLAY_NAME' } -end -``` - -**Test if any alert rule templates exist in the resource group.** - -```ruby -describe azure_sentinel_alert_rule_templates(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME') do - it { should exist } -end -``` - -**Test that there aren't any alert rule templates in a resource group.** - -```ruby -**Should not exist if no alert rule templates are in the resource group.** - -describe azure_sentinel_alert_rule_templates(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME') do - it { should_not exist } -end -``` - -## Azure Permissions - -{{% azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_incidents_resource.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_incidents_resource.md deleted file mode 100644 index cb53d724d6..0000000000 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_incidents_resource.md +++ /dev/null @@ -1,124 +0,0 @@ -+++ -title = "azure_sentinel_incidents_resource Resource" -platform = "azure" -draft = false -gh_repo = "inspec-azure" - -[menu.inspec] -title = "azure_sentinel_incidents_resource" -identifier = "inspec/resources/azure/azure_sentinel_incidents_resource Resource" -parent = "inspec/resources/azure" -+++ - -Use the `azure_sentinel_incidents_resource` InSpec audit resource to test properties of an Azure Azure Sentinel incident. - -## Azure Rest API Version, Endpoint, And HTTP Client Parameters - -This resource interacts with API versions supported by the resource provider. -The `api_version` can be defined as a resource parameter. -If not provided, the latest version will be used. -For more information, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md" >}}). - -Unless defined, `azure_cloud` global endpoint, and default values for the HTTP client will be used. -For more information, refer to the resource pack [README](https://github.com/inspec/inspec-azure/blob/main/README.md). -For api related info : [`Azure Azure Sentinel incident Docs`](https://docs.microsoft.com/en-us/rest/api/securityinsights/incidents/get). - - -## Installation - -{{% inspec_azure_install %}} - -## Syntax - -`resource_group` and `incident_id`, `workspace_name` must be given as parameters. - -```ruby -describe azure_sentinel_incidents_resource(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME', incident_id: 'INCIDENT_ID') do - #... -end -``` - -## Parameters - -`resource_group` -: Azure resource group that the targeted resource resides in. - -`workspace_name` -: Name for the workspace that you want to create your Azure Sentinel incident in. - -`incident_id` -: The Azure Sentinel incident name. - -All the parameter sets needs be provided for a valid query: -- `resource_group` , `workspace_name` and `incident_id` - -## Properties - -`name` -: Name of the Azure resource to test. - -`id` -: The Azure Sentinel incident type. - -`properties` -: The Properties of the Resource. - -`properties.severity` -: The severity of the incident. - -`properties.status` -: The status of the incident. - -`properties.owner.email` -: The email of the user the incident is assigned to. - -`properties.owner.userPrincipalName` -: The user principal name of the user the incident is assigned to. - -`properties.owner.assignedTo` -: The name of the user the incident is assigned to. - -## Examples - -**Test The Properties of an Incident.** - -```ruby -describe azure_sentinel_incidents_resource(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME', incident_id: 'INCIDENT_ID') do - it { should exist } - its('name') { should eq 'AZURE_RESOURCE_NAME' } - its('type') { should eq 'Microsoft.SecurityInsights/Incidents' } - its('properties.severity') { should eq 'Informational' } - its('properties.status') { should eq 'New' } - its('properties.owner.email') { should eq 'OWNER_EMAIL' } - its('properties.owner.userPrincipalName') { should eq 'PRINCIPAL_NAME' } - its('properties.owner.assignedTo') { should eq 'OWNER_NAME' } -end -``` - -**Test That An Azure Sentinel Incident Exists.** - -```ruby -describe azure_sentinel_incidents_resource(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME', incident_id: 'INCIDENT_ID') do - it { should exist } -end -``` - -**Test That An Azure Sentinel Incident Does Not Exist.** - - ```ruby - describe azure_sentinel_incidents_resource(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME', incident_id: 'INCIDENT_ID') do - it { should_not exist } - end - ``` - -**Test properties of a sentinel_incident.** - - ```ruby - describe azure_sentinel_incidents_resource(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME', incident_id: 'INCIDENT_ID') do - its('name') { should eq 'INCIDENT_ID' } - end - ``` - -## Azure Permissions - -{{% azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_incidents_resources.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_incidents_resources.md deleted file mode 100644 index 3465db9e1a..0000000000 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sentinel_incidents_resources.md +++ /dev/null @@ -1,138 +0,0 @@ -+++ -title = "azure_sentinel_incidents_resources Resource" -platform = "azure" -draft = false -gh_repo = "inspec-azure" - -[menu.inspec] -title = "azure_sentinel_incidents_resources" -identifier = "inspec/resources/azure/azure_sentinel_incidents_resources Resource" -parent = "inspec/resources/azure" -+++ - -Use the `azure_sentinel_incidents_resources` InSpec audit resource to test properties of Azure Sentinel incidents for a resource group or the entire subscription. - -## Azure Rest API Version, Endpoint, And HTTP Client Parameters - -This resource interacts with API versions supported by the resource provider. -The `api_version` can be defined as a resource parameter. -If not provided, the latest version will be used. -For more information, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md" >}}). - -Unless defined, `azure_cloud` global endpoint, and default values for the HTTP client will be used. -For more information, refer to the resource pack [README](https://github.com/inspec/inspec-azure/blob/main/README.md). - -## Installation - -{{% inspec_azure_install %}} - -## Syntax - -An `azure_sentinel_incidents_resources` resource block returns all Azure sentinel incident, either within a resource group (if provided), or within an entire Subscription. - -```ruby -describe azure_sentinel_incidents_resources(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME') do - #... -end -``` - -`resource_group` and `workspace_name` are required parameters. - - -## Parameters - -`resource_group` -: Azure resource group that the targeted resource resides in. - -`workspace_name` -: Azure Workspace Name for which Azure Sentinel incident are being retrieved. - -## Properties - -`names` -: A list of the unique resource names. - -: **Field**: `name` - -`ids` -: A list of Azure Sentinel incident IDs . - -: **Field**: `id` - -`properties` -: A list of properties for the resource. - -: **Field**: `properties` - -`descriptions` -: A list of descriptions for each resource. - -: **Field**: `description` - -`severities` -: The severity of the incident. - -: **Field**: `severity` - -`statuses` -: The status of the incident. - -: **Field**: `status` - -`owner_emails` -: The email of the user the incident is assigned to. - -: **Field**: `owner_email` - -`owner_userPrincipalNames` -: The user principal name of the user the incident is assigned to. - -: **Field**: `owner_userPrincipalName` - -`owner_assignedTos` -: The name of the user the incident is assigned to. - -: **Field**: `owner_assignedTo` - -{{% inspec_filter_table %}} - -## Examples - -**Test Properties of Incidents in a Resource Group.** - -```ruby -describe azure_sentinel_incidents_resource(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME') do - it { should exist } - its('names') { should include 'RESOURCE_NAME' } - its('types') { should include 'Microsoft.SecurityInsights/Incidents' } - its('titles') { should include 'TITLE' } - its('descriptions') { should include 'DESCRIPTION_TEXT' } - its('severities') { should include 'Informational' } - its('statuses') { should include 'New' } - its('owner_emails') { should include 'EMAIL_ADDRESS' } - its('owner_userPrincipalNames') { should include 'PRINCIPAL_NAME' } - its('owner_assignedTos') { should include 'ASSIGNED_TO_NAME' } -end -``` - -**Test If Any Azure Sentinel Incident Exists in a Resource Group.** - -```ruby -describe azure_sentinel_incidents_resources(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME') do - it { should exist } -end -``` - -**Test That There Aren't Any Azure Sentinel Incident in a Resource Group.** - -```ruby -**Should not exist if no Azure Sentinel incident are in the resource group.** - -describe azure_sentinel_incidents_resources(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME') do - it { should_not exist } -end -``` - -## Azure Permissions - -{{% azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_namespace.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_namespace.md new file mode 100644 index 0000000000..c622e0aa8c --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_namespace.md @@ -0,0 +1,120 @@ ++++ +title = "azure_service_bus_namespace Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_bus_namespace" +identifier = "inspec/resources/azure/azure_service_bus_namespace Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_bus_namespace` InSpec audit resource to test the properties related to an Azure Service Bus Namespace. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +`name` and `resource_group` are required parameters. + +```ruby +describe azure_service_bus_namespace(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_BUS_NAMESPACE') do + it { should exist } + its('type') { should eq 'Microsoft.ServiceBus/Namespaces' } + its('location') { should eq 'East US' } +end +``` + +```ruby +describe azure_service_bus_namespace(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_BUS_NAMESPACE') do + it { should exist } +end +``` + +## Parameters + +`name` _(required)_ +: Name of the Azure Service Bus namespaces to test. + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`id` +: Resource ID. + +`name` +: Resource name. + +`type` +: Resource type. `Microsoft.ServiceBus/Namespaces`. + +`location` +: The Geo-location where the resource lives. + +`properties` +: The properties of the Service Bus Namespace. + +`properties.serviceBusEndpoint` +: Endpoint you can use to perform Service Bus operations. + +`properties.metricId` +: Identifier for Azure Insights metrics. + +`properties.provisioningState` +: Provisioning state of the Namespace. + +`sku.name` +: Name of this SKU. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/servicebus/stable/namespaces/get) for other properties available. + +## Examples + +### Test that the Service Bus Namespaces are provisioned successfully + +```ruby +describe azure_service_bus_namespace(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_BUS_NAMESPACE') do + its('properties.provisioningState') { should eq 'Succeeded' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If a Service Bus Namespace is found, it will exist. + +describe azure_service_bus_namespace(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_BUS_NAMESPACE') do + it { should exist } +end +``` + +### not_exists + +```ruby +# If Service Bus Namespace is not found, it will not exist. + +describe azure_service_bus_namespace(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_BUS_NAMESPACE') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_namespaces.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_namespaces.md new file mode 100644 index 0000000000..78fc78840f --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_namespaces.md @@ -0,0 +1,144 @@ ++++ +title = "azure_service_bus_namespaces Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_bus_namespaces" +identifier = "inspec/resources/azure/azure_service_bus_namespaces Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_bus_namespaces` InSpec audit resource to test the properties related to all Azure Service Bus Namespaces within a project. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_service_bus_namespaces` resource block returns all Azure Service Bus Namespaces within a project. + +```ruby +describe azure_service_bus_namespaces do + #... +end +``` + +## Parameters + +`resource_group` _(optional)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`ids` +: A list of resource IDs. + +: **Field**: `id` + +`names` +: A list of resource names. + +: **Field**: `name` + +`types` +: A list of the resource types. + +: **Field**: `type` + +`properties` +: A list of properties for all the Service Bus Namespaces. + +: **Field**: `properties` + +`locations` +: A list of the Geo-locations. + +: **Field**: `location` + +`serviceBusEndpoints` +: A list of endpoints you can use to perform Service Bus operations. + +: **Field**: `serviceBusEndpoint` + +`metricIds` +: A list of identifiers for Azure Insights metrics. + +: **Field**: `metricId` + +`provisioningStates` +: A list of provisioning states of the namespace. + +: **Field**: `provisioningState` + +`sku_names` +: A list of names for the sku. + +: **Field**: `sku_name` + +`sku_tiers` +: A list of tiers for the sku. + +: **Field**: `sku_tier` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Loop through Service Bus Namespaces by their names + +```ruby +azure_service_bus_namespaces(resource_group: 'RESOURCE_GROUP').names.each do |name| + describe azure_service_bus_namespace(resource_group: 'RESOURCE_GROUP', name: name) do + it { should exist } + end +end +``` + +### Test that there are Service Bus Namespaces that are successfully provisioned + +```ruby +describe azure_service_bus_namespaces(resource_group: 'RESOURCE_GROUP').where(provisioningState: 'Succeeded') do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no Service Bus Namespaces are present. + +describe azure_service_bus_namespaces(resource_group: 'RESOURCE_GROUP') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Service Bus Namespaces. + +describe azure_service_bus_namespaces(resource_group: 'RESOURCE_GROUP') do + it { should exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_regions.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_regions.md new file mode 100644 index 0000000000..45cf031375 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_regions.md @@ -0,0 +1,119 @@ ++++ +title = "azure_service_bus_regions Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_bus_regions" +identifier = "inspec/resources/azure/azure_service_bus_regions Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_bus_regions` InSpec audit resource to test the properties related to all Azure Service Bus regions. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_service_bus_regions` resource block returns all Azure Service Bus regions. + +```ruby +describe azure_service_bus_regions(sku: 'SKU_NAME') do + #... +end +``` + +## Parameters + +`sku` _(required)_ +: The sku type. + +## Properties + +`ids` +: A list of resource IDs. + +: **Field**: `id` + +`names` +: A list of resource names. + +: **Field**: `name` + +`types` +: A list of the resource types. + +: **Field**: `type` + +`properties` +: A list of properties for all the Service Bus regions. + +: **Field**: `properties` + +`locations` +: A list of the resource locations. + +: **Field**: `location` + +`codes` +: A list of region codes. + +: **Field**: `code` + +`fullNames` +: A list of full names of the regions. + +: **Field**: `fullName` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Test that there are Service Bus regions that are successfully provisioned + +```ruby +describe azure_service_bus_regions(sku: 'SKU_NAME').where(code: 'Central US') do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no Service Bus regions are present. + +describe azure_service_bus_regions(sku: 'SKU_NAME') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Service Bus region. + +describe azure_service_bus_regions(sku: 'SKU_NAME') do + it { should exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscription.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscription.md new file mode 100644 index 0000000000..6bd244b052 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscription.md @@ -0,0 +1,112 @@ ++++ +title = "azure_service_bus_subscription Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_bus_subscription" +identifier = "inspec/resources/azure/azure_service_bus_subscription Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_bus_subscription` InSpec audit resource to test the properties related to an Azure Service Bus subscription. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +```ruby +describe azure_service_bus_subscription(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', topic_name: 'TOPIC_NAME', name: 'SUBSCRIPTION_NAME') do + it { should exist } + its('type') { should eq 'Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules' } + its('properties.filterType') { should eq 'SqlFilter' } +end +``` + +## Parameters + +`name` _(required)_ +: Name of the Azure Service Bus subscription to test. + +`namespace_name` _(required)_ +: The namespace name. + +`topic_name` _(required)_ +: The topic name. + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`id` +: Resource ID. + +`name` +: Resource name. + +`type` +: Resource type. + +`properties` +: The properties of the Service Bus subscription. + +`properties.lockDuration` +: ISO 8061 lock duration timespan for the subscription. The default value is **1 minute**. + +`properties.status` +: Enumerates the possible values for the status of a messaging entity. + +`properties.countDetails` +: Message count details. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/servicebus/stable/subscriptions/get) for other properties available. + +## Examples + +### Test that the Service Bus subscription is active + +```ruby +describe azure_service_bus_subscription(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', topic_name: 'TOPIC_NAME', name: 'SUBSCRIPTION_NAME') do + its('properties.status') { should eq 'Active' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If a Service Bus subscription is found, it will exist. + +describe azure_service_bus_subscription(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', topic_name: 'TOPIC_NAME', name: 'SUBSCRIPTION_NAME') do + it { should exist } +end +``` + +### not_exists + +```ruby +# If a Service Bus subscription is not found, it will not exist. + +describe azure_service_bus_subscription(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', topic_name: 'TOPIC_NAME', name: 'SUBSCRIPTION_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscription_rule.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscription_rule.md new file mode 100644 index 0000000000..7b51209fbc --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscription_rule.md @@ -0,0 +1,115 @@ ++++ +title = "azure_service_bus_subscription_rule Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_bus_subscription_rule" +identifier = "inspec/resources/azure/azure_service_bus_subscription_rule Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_bus_subscription_rule` InSpec audit resource to test the properties related to an Azure Service Bus subscription rule. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +```ruby +describe azure_service_bus_subscription_rule(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', subscription_name: "SUBSCRIPTION_NAME", topic_name: 'TOPIC_NAME', name: 'SUBSCRIPTION_RULE_NAME') do + it { should exist } + its('type') { should eq 'Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules' } + its('properties.filterType') { should eq 'SqlFilter' } +end +``` + +## Parameters + +`name` _(required)_ +: Name of the Azure Service Bus subscription rule to test. + +`namespace_name` _(required)_ +: The namespace name. + +`subscription_name` _(required)_ +: The subscription name. + +`topic_name` _(required)_ +: The topic name. + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`id` +: Resource ID. + +`name` +: Resource name. + +`type` +: Resource type. + +`properties` +: The properties of the Service Bus subscription rule. + +`properties.action` +: Represents the filter actions that are allowed for the transformation of a message that has been matched by a filter expression. + +`properties.filterType` +: Filter type that is evaluated against a BrokeredMessage. + +`properties.sqlFilter` +: Properties of sqlFilter. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/servicebus/stable/rules/get) for other properties available. + +## Examples + +### Test that the Service Bus subscription rule is of SQL Filter type + +```ruby +describe azure_service_bus_subscription_rule(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', subscription_name: "SUBSCRIPTION_NAME", topic_name: 'TOPIC_NAME', name: 'SUBSCRIPTION_RULE_NAME') do + its('properties.filterType') { should eq 'SqlFilter' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If a Service Bus subscription rule is found, it will exist. + +describe azure_service_bus_subscription_rule(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', subscription_name: "SUBSCRIPTION_NAME", topic_name: 'TOPIC_NAME', name: 'SUBSCRIPTION_RULE_NAME') do + it { should exist } +end +``` + +### not_exists + +```ruby +# If a Service Bus subscription rule is not found, it will not exist. + +describe azure_service_bus_subscription_rule(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', subscription_name: "SUBSCRIPTION_NAME", topic_name: 'TOPIC_NAME', name: 'SUBSCRIPTION_RULE_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscription_rules.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscription_rules.md new file mode 100644 index 0000000000..8564e46225 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscription_rules.md @@ -0,0 +1,123 @@ ++++ +title = "azure_service_bus_subscription_rules Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_bus_subscription_rules" +identifier = "inspec/resources/azure/azure_service_bus_subscription_rules Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_bus_subscription_rules` InSpec audit resource to test the properties related to all Azure Service Bus subscription rules. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_service_bus_subscription_rules` resource block returns all Azure Service Bus subscription rules. + +```ruby +describe azure_service_bus_subscription_rules(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', subscription_name: 'SUBSCRIPTION_NAME', topic_name: 'TOPIC_NAME') do + #... +end +``` + +## Parameters + +`namespace_name` _(required)_ +: The namespace name. + +`subscription_name` _(required)_ +: The subscription name. + +`topic_name` _(required)_ +: The topic name. + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`ids` +: A list of resource IDs. + +: **Field**: `id` + +`names` +: A list of resource names. + +: **Field**: `name` + +`types` +: A list of the resource types. + +: **Field**: `type` + +`properties` +: A list of properties for all the Service Bus subscription rules. + +: **Field**: `properties` + +`filterTypes` +: A list of the filter types. + +: **Field**: `filterType` + +`sqlFilter` +: A list of sqlFilters. + +: **Field**: `sqlFilter` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Test that there are Service Bus subscription rules that are of SQL Filter type + +```ruby +describe azure_service_bus_subscription_rules(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', subscription_name: 'SUBSCRIPTION_NAME', topic_name: 'TOPIC_NAME').where(filterType: 'SqlFilter') do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no Service Bus subscription rules are present. + +describe azure_service_bus_subscription_rules(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', subscription_name: 'SUBSCRIPTION_NAME', topic_name: 'TOPIC_NAME') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Service Bus subscription rule. + +describe azure_service_bus_subscription_rules(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', subscription_name: 'SUBSCRIPTION_NAME', topic_name: 'TOPIC_NAME') do + it { should exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscriptions.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscriptions.md new file mode 100644 index 0000000000..8023944dd3 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_subscriptions.md @@ -0,0 +1,120 @@ ++++ +title = "azure_service_bus_subscriptions Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_bus_subscriptions" +identifier = "inspec/resources/azure/azure_service_bus_subscriptions Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_bus_subscriptions` InSpec audit resource to test the properties related to all Azure Service Bus subscriptions. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_service_bus_subscriptions` resource block returns all Azure Service Bus subscriptions. + +```ruby +describe azure_service_bus_subscriptions(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', topic_name: 'TOPIC_NAME') do + #... +end +``` + +## Parameters + +`namespace_name` _(required)_ +: The namespace name. + +`topic_name` _(required)_ +: The topic name. + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`ids` +: A list of resource IDs. + +: **Field**: `id` + +`names` +: A list of resource names. + +: **Field**: `name` + +`types` +: A list of the resource types. + +: **Field**: `type` + +`properties` +: A list of properties for all the Service Bus subscriptions. + +: **Field**: `properties` + +`lockDurations` +: A list of the lock duration timespans. + +: **Field**: `lockDuration` + +`statuses` +: A list of statuses of a messaging entity. + +: **Field**: `status` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Test that there are Service Bus subscriptions that are active + +```ruby +describe azure_service_bus_subscriptions(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', topic_name: 'TOPIC_NAME').where(status: 'Active') do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no Service Bus subscriptions are present. + +describe azure_service_bus_subscriptions(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', topic_name: 'TOPIC_NAME') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Service Bus subscription. + +describe azure_service_bus_subscriptions(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', topic_name: 'TOPIC_NAME') do + it { should exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_topic.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_topic.md new file mode 100644 index 0000000000..1972319b82 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_topic.md @@ -0,0 +1,117 @@ ++++ +title = "azure_service_bus_topic Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_bus_topic" +identifier = "inspec/resources/azure/azure_service_bus_topic Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_bus_topic` InSpec audit resource to test the properties related to an Azure Service Bus topic. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +```ruby +describe azure_service_bus_topic(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME', name: 'SERVICE_BUS_NAMESPACE') do + it { should exist } + its('type') { should eq 'Microsoft.ServiceBus/Namespaces/Topics' } +end +``` + +```ruby +describe azure_service_bus_topic(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME', name: 'SERVICE_BUS_NAMESPACE') do + it { should exist } +end +``` + +## Parameters + +`name` _(required)_ +: Name of the Azure Service Bus topics to test. + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +`namespace_name` _(required)_ +: Name of the namespace where the topic resides. + +## Properties + +`id` +: Resource ID. + +`name` +: Resource name. + +`type` +: Resource type. `Microsoft.ServiceBus/Namespaces/Topics`. + +`properties` +: The properties of the Service Bus topic. + +`properties.maxSizeInMegabytes` +: Maximum size of the topic in megabytes, the memory size allocated for the topic. The default value is **1024**. + +`properties.sizeInBytes` +: Size of the topic, in bytes. + +`properties.status` +: Enumerates the possible values for the status of a messaging entity. + +`properties.countDetails` +: Message count details. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/servicebus/stable/topics/get) for other properties available. + +## Examples + +### Test that the Service Bus topics are provisioned successfully + +```ruby +describe azure_service_bus_topic(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME', name: 'SERVICE_BUS_NAMESPACE') do + its('properties.status') { should eq 'Active' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If a Service Bus topic is found, it will exist. + +describe azure_service_bus_topic(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME', name: 'SERVICE_BUS_NAMESPACE') do + it { should exist } +end +``` + +### not_exists + +```ruby +# If Service Bus topic is not found, it will not exist. + +describe azure_service_bus_topic(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME', name: 'SERVICE_BUS_NAMESPACE') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_topics.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_topics.md new file mode 100644 index 0000000000..4d4a8e5106 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_bus_topics.md @@ -0,0 +1,139 @@ ++++ +title = "azure_service_bus_topics Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_bus_topics" +identifier = "inspec/resources/azure/azure_service_bus_topics Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_bus_topics` InSpec audit resource to test the properties related to all Azure Service Bus topics within a project. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_service_bus_topics` resource block returns all Azure Service Bus topics within a project. + +`name`, `namespace_name`, and `resource_group` are the required parameters. + +```ruby +describe azure_service_bus_topics(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME') do + #... +end +``` + +## Parameters + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. `MyResourceGroup`. + +`namespace_name` _(required)_ +: Name of the namespace where the topic resides. + +## Properties + +`ids` +: A list of resource IDs. + +: **Field**: `id` + +`names` +: A list of resource names. + +: **Field**: `name` + +`types` +: A list of the resource types. + +: **Field**: `type` + +`properties` +: A list of properties for all the Service Bus topics. + +: **Field**: `properties` + +`maxSizeInMegabytes` +: A list of maximum sizes of the topics. + +: **Field**: `maxSizeInMegabytes` + +`sizeInBytes` +: A list of sizes of the topics. + +: **Field**: `sizeInBytes` + +`statuses` +: A list of the status of a messaging entity. + +: **Field**: `status` + +`countDetails` +: A list of message count details. + +: **Field**: `countDetails` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Loop through Service Bus topics by their names + +```ruby +azure_service_bus_topics(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME').names.each do |name| + describe azure_service_bus_topic(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME', name: name) do + it { should exist } + end +end +``` + +### Test that there are Service Bus topics that are successfully provisioned + +```ruby +describe azure_service_bus_topics(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME').where(status: 'Active') do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no Service Bus topics are present. + +describe azure_service_bus_topics(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Service Bus topic. + +describe azure_service_bus_topics(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME') do + it { should exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_application.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_application.md new file mode 100644 index 0000000000..0258050abd --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_application.md @@ -0,0 +1,118 @@ ++++ +title = "azure_service_fabric_mesh_application Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_fabric_mesh_application" +identifier = "inspec/resources/azure/azure_service_fabric_mesh_application Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_fabric_mesh_application` InSpec audit resource to test the properties of an Azure Service Fabric Mesh application. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +```ruby +describe azure_service_fabric_mesh_application(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_APP_NAME') do + it { should exist } + its('type') { should eq 'Microsoft.ServiceFabricMesh/applications' } + its('location') { should eq 'eastus' } +end +``` + +```ruby +describe azure_service_fabric_mesh_application(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_APP_NAME') do + it { should exist } +end +``` + +## Parameters + +`name` _(required)_ +: Name of the Azure Service Fabric Mesh applications to test. + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`id` +: Resource ID. + +`name` +: Resource name. + +`type` +: Resource type. `Microsoft.ServiceFabricMesh/applications`. + +`location` +: The Geo-location where the resource lives. + +`properties` +: The properties of the Service Fabric Mesh application. + +`properties.description` +: User-readable description of the application. + +`properties.debugParams` +: Internal use. + +`properties.provisioningState` +: State of the resource. + +`properties.healthState` +: The health state of a resource such as application, Service, or Network. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/servicefabric/sfmeshrp-api-application_get) for other properties available. + +## Examples + +### Test that the Service Fabric Mesh application is provisioned successfully + +```ruby +describe azure_service_fabric_mesh_application(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_APP_NAME') do + its('properties.provisioningState') { should eq 'Succeeded' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If a Service Fabric Mesh application is found, it will exist. + +describe azure_service_fabric_mesh_application(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_APP_NAME') do + it { should exist } +end +``` + +### not_exists + +```ruby +# If a Service Fabric Mesh application is not found, it will not exist. + +describe azure_service_fabric_mesh_application(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_APP_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_applications.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_applications.md new file mode 100644 index 0000000000..3864e83f09 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_applications.md @@ -0,0 +1,134 @@ ++++ +title = "azure_service_fabric_mesh_applications Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_fabric_mesh_applications" +identifier = "inspec/resources/azure/azure_service_fabric_mesh_applications Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_fabric_mesh_applications` InSpec audit resource to test the properties of all Azure Service Fabric Mesh applications. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_service_fabric_mesh_applications` resource block returns all Azure Service Fabric Mesh applications. + +```ruby +describe azure_service_fabric_mesh_applications do + #... +end +``` + +## Parameters + +`resource_group` _(optional)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`ids` +: A list of resource IDs. + +: **Field**: `id` + +`names` +: A list of resource names. + +: **Field**: `name` + +`types` +: A list of the resource types. + +: **Field**: `type` + +`properties` +: A list of Properties for all the Service Fabric Mesh applications. + +: **Field**: `properties` + +`locations` +: A list of the Geo-locations. + +: **Field**: `location` + +`provisioningStates` +: A list of provisioning states of the Service Fabric Mesh applications. + +: **Field**: `provisioningState` + +`healthStates` +: A list of the health states of a resource such as application, Service, or Network. + +: **Field**: `healthState` + +`serviceNames` +: A list of the services in the application. + +: **Field**: `serviceNames` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Loop through Service Fabric Mesh applications by their names + +```ruby +azure_service_fabric_mesh_applications(resource_group: 'RESOURCE_GROUP').names.each do |name| + describe azure_service_fabric_mesh_application(resource_group: 'RESOURCE_GROUP', name: name) do + it { should exist } + end +end +``` + +### Test that there are Service Fabric Mesh applications that are successfully provisioned + +```ruby +describe azure_service_fabric_mesh_applications(resource_group: 'RESOURCE_GROUP').where(provisioningState: 'Succeeded') do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no Service Fabric Mesh applications are present. + +describe azure_service_fabric_mesh_applications(resource_group: 'RESOURCE_GROUP') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Service Fabric Mesh application. + +describe azure_service_fabric_mesh_applications(resource_group: 'RESOURCE_GROUP') do + it { should exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_network.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_network.md new file mode 100644 index 0000000000..601032fac9 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_network.md @@ -0,0 +1,119 @@ ++++ +title = "azure_service_fabric_mesh_network Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_fabric_mesh_network" +identifier = "inspec/resources/azure/azure_service_fabric_mesh_network Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_fabric_mesh_network` InSpec audit resource to test the properties of an Azure Service Fabric Mesh network. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +`name` and `resource_group` are required parameters. + +```ruby +describe azure_service_fabric_mesh_network(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_NETWORK_NAME') do + it { should exist } + its('type') { should eq 'Microsoft.ServiceFabricMesh/networks' } + its('location') { should eq 'eastus' } +end +``` + +```ruby +describe azure_service_fabric_mesh_network(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_NETWORK_NAME') do + it { should exist } +end +``` + +## Parameters + +`name` +: Name of the Azure Service Fabric Mesh networks to test. + +`resource_group` +: Azure resource group where the targeted resource resides. + +The parameter set that should be provided for a valid query is `resource_group` and `name`. + +## Properties + +`id` +: Resource ID. + +`name` +: Resource name. + +`type` +: Resource type. `Microsoft.ServiceFabricMesh/networks`. + +`location` +: The Geo-location where the resource lives. + +`properties` +: The properties of the Service Fabric Mesh network. + +`properties.addressPrefix` +: the address prefix for this network. + +`properties.provisioningState` +: State of the resource. + +`properties.ingressConfig.qosLevel` +: The QoS tier for ingress. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/servicefabric/sfmeshrp-api-network_get) for other properties available. + +## Examples + +### Test that the Service Fabric Mesh network is provisioned successfully + +```ruby +describe azure_service_fabric_mesh_network(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_NETWORK_NAME') do + its('properties.provisioningState') { should eq 'Succeeded' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If a Service Fabric Mesh network is found, it will exist. + +describe azure_service_fabric_mesh_network(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_NETWORK_NAME') do + it { should exist } +end +``` + +### not_exists + +```ruby +# If a Service Fabric Mesh network is not found, it will not exist. + +describe azure_service_fabric_mesh_network(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_NETWORK_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_networks.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_networks.md new file mode 100644 index 0000000000..e1708a2c78 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_networks.md @@ -0,0 +1,129 @@ ++++ +title = "azure_service_fabric_mesh_networks Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_fabric_mesh_networks" +identifier = "inspec/resources/azure/azure_service_fabric_mesh_networks Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_fabric_mesh_networks` InSpec audit resource to test the properties of all Azure Service Fabric Mesh networks. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_service_fabric_mesh_networks` resource block returns all Azure Service Fabric Mesh networks. + +```ruby +describe azure_service_fabric_mesh_networks do + #... +end +``` + +## Parameters + +`resource_group` _(optional)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`ids` +: A list of resource IDs. + +: **Field**: `id` + +`names` +: A list of resource names. + +: **Field**: `name` + +`types` +: A list of the resource types. + +: **Field**: `type` + +`properties` +: A list of Properties for all the Service Fabric Mesh networks. + +: **Field**: `properties` + +`locations` +: A list of the Geo-locations. + +: **Field**: `location` + +`provisioningStates` +: A list of provisioning states of the Service Fabric Mesh networks. + +: **Field**: `provisioningState` + +`addressPrefixes` +: A list of address prefixes. + +: **Field**: `addressPrefix` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Loop through Service Fabric Mesh networks by their names + +```ruby +azure_service_fabric_mesh_networks(resource_group: 'RESOURCE_GROUP').names.each do |name| + describe azure_service_fabric_mesh_network(resource_group: 'RESOURCE_GROUP', name: name) do + it { should exist } + end +end +``` + +### Test that there are Service Fabric Mesh networks that are successfully provisioned + +```ruby +describe azure_service_fabric_mesh_networks(resource_group: 'RESOURCE_GROUP').where(provisioningState: 'Succeeded') do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no Service Fabric Mesh networks are present. + +describe azure_service_fabric_mesh_networks(resource_group: 'RESOURCE_GROUP') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Service Fabric Mesh networks. + +describe azure_service_fabric_mesh_networks(resource_group: 'RESOURCE_GROUP') do + it { should exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_replica.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_replica.md new file mode 100644 index 0000000000..10c5ae3af6 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_replica.md @@ -0,0 +1,109 @@ ++++ +title = "azure_service_fabric_mesh_replica Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_fabric_mesh_replica" +identifier = "inspec/resources/azure/azure_service_fabric_mesh_replica Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_fabric_mesh_replica` InSpec audit resource to test the properties of an Azure Service Fabric Mesh replica. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +```ruby +describe azure_service_fabric_mesh_replica(resource_group: 'RESOURCE_GROUP', application_name: 'SERVICE_FABRIC_MESH_APPLICATION_NAME', service_name: 'SERVICE_FABRIC_MESH_SERVICE_NAME', name: 'SERVICE_FABRIC_MESH_SERVICE_REPLICA_NAME') do + it { should exist } + its('type') { should eq 'Microsoft.ServiceFabricMesh/applications' } + its('location') { should eq 'eastus' } +end +``` + +```ruby +describe azure_service_fabric_mesh_replica(resource_group: 'RESOURCE_GROUP', application_name: 'SERVICE_FABRIC_MESH_APPLICATION_NAME', service_name: 'SERVICE_FABRIC_MESH_SERVICE_NAME', name: 'SERVICE_FABRIC_MESH_SERVICE_REPLICA_NAME') do + it { should exist } +end +``` + +## Parameters + +`name` _(required)_ +: Name of the Azure Service Fabric Mesh replicas to test. + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +`application_name` _(required)_ +: The identity of the application. + +`service_name` _(required)_ +: The identity of the service. + +## Properties + +`osType` +: The Operating system type required by the code in service. + +`codePackages` +: Describes the set of code packages that form the service. + +`networkRefs` +: The names of the private networks that this service needs to be part. + +`replicaName` +: Name of the replica. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/servicefabric/sfmeshrp-api-replica_get) for other properties available. + +## Examples + +### Test that the Service Fabric Mesh replica Replica is equal to 1 + +```ruby +describe azure_service_fabric_mesh_replica(resource_group: 'RESOURCE_GROUP', application_name: 'SERVICE_FABRIC_MESH_APPLICATION_NAME', service_name: 'SERVICE_FABRIC_MESH_SERVICE_NAME', name: 'SERVICE_FABRIC_MESH_SERVICE_REPLICA_NAME') do + its('replicaName') { should eq '1' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If a Service Fabric Mesh replica is found, it will exist. + +describe azure_service_fabric_mesh_replica(resource_group: 'RESOURCE_GROUP', application_name: 'SERVICE_FABRIC_MESH_APPLICATION_NAME', service_name: 'SERVICE_FABRIC_MESH_SERVICE_NAME', name: 'SERVICE_FABRIC_MESH_SERVICE_REPLICA_NAME') do + it { should exist } +end +``` + +### not_exists + +```ruby +# If a Service Fabric Mesh replica is not found, it will not exist. + +describe azure_service_fabric_mesh_replica(resource_group: 'RESOURCE_GROUP', application_name: 'SERVICE_FABRIC_MESH_APPLICATION_NAME', service_name: 'SERVICE_FABRIC_MESH_SERVICE_NAME', name: 'SERVICE_FABRIC_MESH_SERVICE_REPLICA_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_replicas.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_replicas.md new file mode 100644 index 0000000000..30f15cdbab --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_replicas.md @@ -0,0 +1,110 @@ ++++ +title = "azure_service_fabric_mesh_replicas Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_fabric_mesh_replicas" +identifier = "inspec/resources/azure/azure_service_fabric_mesh_replicas Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_fabric_mesh_replicas` InSpec audit resource to test the properties of all Azure Service Fabric Mesh replicas. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_service_fabric_mesh_replicas` resource block returns all Azure Service Fabric Mesh replicas. + +```ruby +describe azure_service_fabric_mesh_replicas(resource_group: 'RESOURCE_GROUP', application_name: 'SERVICE_FABRIC_MESH_APPLICATION_NAME', service_name: 'SERVICE_FABRIC_MESH_SERVICE_NAME') do + #... +end +``` + +## Parameters + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +`application_name` _(required)_ +: The identity of the application. + +`service_name` _(required)_ +: The identity of the service. + +## Properties + +`osTypes` +: A list of OS Types. + +: **Field**: `osType` + +`codePackages` +: A list of code packages. + +: **Field**: `codePackages` + +`networkRefs` +: A list of the network refs. + +: **Field**: `networkRefs` + +`replicaNames` +: A list of the replica names. + +: **Field**: `replicaName` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Test that there are Service Fabric Mesh replicas with at least one replica + +```ruby +describe azure_service_fabric_mesh_replicas(resource_group: 'RESOURCE_GROUP', application_name: 'SERVICE_FABRIC_MESH_APPLICATION_NAME', service_name: 'SERVICE_FABRIC_MESH_SERVICE_NAME').where{ replicaName > 1 } do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no Service Fabric Mesh replicas are present. + +describe azure_service_fabric_mesh_replicas(resource_group: 'RESOURCE_GROUP', application_name: 'SERVICE_FABRIC_MESH_APPLICATION_NAME', service_name: 'SERVICE_FABRIC_MESH_SERVICE_NAME') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Service Fabric Mesh replica. + +describe azure_service_fabric_mesh_replicas(resource_group: 'RESOURCE_GROUP', application_name: 'SERVICE_FABRIC_MESH_APPLICATION_NAME', service_name: 'SERVICE_FABRIC_MESH_SERVICE_NAME') do + it { should exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_service.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_service.md new file mode 100644 index 0000000000..bde3a6f82c --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_service.md @@ -0,0 +1,111 @@ ++++ +title = "azure_service_fabric_mesh_service Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_fabric_mesh_service" +identifier = "inspec/resources/azure/azure_service_fabric_mesh_service Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_fabric_mesh_service` InSpec audit resource to test the properties of an Azure Service Fabric Mesh service. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +```ruby +describe azure_service_fabric_mesh_service(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_SERVICE_NAME') do + it { should exist } + its('type') { should eq 'Microsoft.ServiceFabricMesh/applications' } +end +``` + +```ruby +describe azure_service_fabric_mesh_service(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_SERVICE_NAME') do + it { should exist } +end +``` + +## Parameters + +`name` _(required)_ +: Name of the Azure Service Fabric Mesh service to test. + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`id` +: Resource ID. + +`name` +: Resource name. + +`type` +: Resource type. `Microsoft.ServiceFabricMesh/services`. + +`properties` +: The properties of the **Service Fabric Mesh Service**. + +`properties.osType` +: The Operating system type required by the code in service. + +`properties.replicaCount` +: The number of replicas of the service to create. Defaults to 1 if not specified. + +`properties.healthState` +: Describes the health state of a services resource. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/servicefabric/sfmeshrp-api-service_get) for other properties available. + +## Examples + +### Test that the 'Service Fabric Mesh Service' is healthy + +```ruby +describe azure_service_fabric_mesh_service(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_SERVICE_NAME') do + its('properties.healthState') { should eq 'Ok' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If a Service Fabric Mesh Service is found, it will exist. + +describe azure_service_fabric_mesh_service(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_SERVICE_NAME') do + it { should exist } +end +``` + +### not_exists + +```ruby +# If Service Fabric Mesh Service is not found, it will not exist. + +describe azure_service_fabric_mesh_service(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_SERVICE_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_services.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_services.md new file mode 100644 index 0000000000..f550f3924c --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_services.md @@ -0,0 +1,129 @@ ++++ +title = "azure_service_fabric_mesh_services Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_fabric_mesh_services" +identifier = "inspec/resources/azure/azure_service_fabric_mesh_services Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_fabric_mesh_services` InSpec audit resource to test the properties of all Azure Service Fabric Mesh services within a project. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_service_fabric_mesh_services` resource block returns all Azure service Fabric Mesh services within a project. + +```ruby +describe azure_service_fabric_mesh_services do + #... +end +``` + +## Parameters + +`resource_group` _(optional)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`ids` +: A list of resource IDs. + +: **Field**: `id` + +`names` +: A list of resource names. + +: **Field**: `name` + +`types` +: A list of the resource types. + +: **Field**: `type` + +`properties` +: A list of Properties for all the service Fabric Mesh services. + +: **Field**: `properties` + +`osTypes` +: The Operating system type required by the code in services. + +: **Field**: `replicaCount` + +`replicaCounts` +: The number of replicas of the service to create. Defaults to 1 if not specified. + +: **Field**: `metricId` + +`healthStates` +: The health state of a services resource. + +: **Field**: `healthState` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Loop through service Fabric Mesh services by their names + +```ruby +azure_service_fabric_mesh_services(resource_group: 'RESOURCE_GROUP').names.each do |name| + describe azure_service_fabric_mesh_service(resource_group: 'RESOURCE_GROUP', name: name) do + it { should exist } + end +end +``` + +### Test that there are service Fabric Mesh services that are healthy + +```ruby +describe azure_service_fabric_mesh_services(resource_group: 'RESOURCE_GROUP').where(replicaCounts: 2) do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no service Fabric Mesh services are present. + +describe azure_service_fabric_mesh_services(resource_group: 'RESOURCE_GROUP') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one service Fabric Mesh services. + +describe azure_service_fabric_mesh_services(resource_group: 'RESOURCE_GROUP') do + it { should exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_volume.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_volume.md new file mode 100644 index 0000000000..c9c3ea5d63 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_volume.md @@ -0,0 +1,115 @@ ++++ +title = "azure_service_fabric_mesh_volume Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_fabric_mesh_volume" +identifier = "inspec/resources/azure/azure_service_fabric_mesh_volume Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_fabric_mesh_volume` InSpec audit resource to test the properties of an Azure Service Fabric Mesh volume. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +```ruby +describe azure_service_fabric_mesh_volume(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_VOLUME_NAME') do + it { should exist } + its('type') { should eq 'Microsoft.ServiceFabricMesh/applications' } + its('location') { should eq 'eastus' } +end +``` + +```ruby +describe azure_service_fabric_mesh_volume(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_VOLUME_NAME') do + it { should exist } +end +``` + +## Parameters + +`name` _(required)_ +: Name of the Azure Service Fabric Mesh volumes to test. + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`id` +: Resource ID. + +`name` +: Resource name. + +`type` +: Resource type. `Microsoft.ServiceFabricMesh/applications`. + +`location` +: The Geo-location where the resource lives. + +`properties` +: The properties of the Service Fabric Mesh volume. + +`properties.description` +: User-readable description of the application. + +`properties.provisioningState` +: State of the resource. + +`properties.azureFileParameters.shareName` +: Name of the Azure Files file share that provides storage for the volume. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/servicefabric/sfmeshrp-api-volume_get) for other properties available. + +## Examples + +### Test that the Service Fabric Mesh volume is provisioned successfully + +```ruby +describe azure_service_fabric_mesh_volume(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_VOLUME_NAME') do + its('properties.provisioningState') { should eq 'Succeeded' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If a Service Fabric Mesh volume is found, it will exist. + +describe azure_service_fabric_mesh_volume(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_VOLUME_NAME') do + it { should exist } +end +``` + +### not_exists + +```ruby +# If Service Fabric Mesh volume is not found, it will not exist. + +describe azure_service_fabric_mesh_volume(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_VOLUME_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_volumes.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_volumes.md new file mode 100644 index 0000000000..ed537b52f5 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_service_fabric_mesh_volumes.md @@ -0,0 +1,134 @@ ++++ +title = "azure_service_fabric_mesh_volumes Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_service_fabric_mesh_volumes" +identifier = "inspec/resources/azure/azure_service_fabric_mesh_volumes Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_service_fabric_mesh_volumes` InSpec audit resource to test the properties of all Azure Service Fabric Mesh volumes. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_service_fabric_mesh_volumes` resource block returns all Azure Service Fabric Mesh volumes. + +```ruby +describe azure_service_fabric_mesh_volumes do + #... +end +``` + +## Parameters + +`resource_group` _(optional)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`ids` +: A list of resource IDs. + +: **Field**: `id` + +`names` +: A list of resource names. + +: **Field**: `name` + +`types` +: A list of the resource types. + +: **Field**: `type` + +`properties` +: A list of Properties for all the Service Fabric Mesh volumes. + +: **Field**: `properties` + +`locations` +: A list of the Geo-locations. + +: **Field**: `location` + +`provisioningStates` +: A list of provisioning states of the Service Fabric Mesh volumes. + +: **Field**: `provisioningState` + +`providers` +: A list of providers of the volume. + +: **Field**: `provider` + +`shareNames` +: A list of the Name of the Azure Files file share that provides storage for the volume. + +: **Field**: `shareName` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Loop through Service Fabric Mesh volumes by their names + +```ruby +azure_service_fabric_mesh_volumes(resource_group: 'RESOURCE_GROUP').names.each do |name| + describe azure_service_fabric_mesh_volume(resource_group: 'RESOURCE_GROUP', name: name) do + it { should exist } + end +end +``` + +### Test that there are Service Fabric Mesh volumes that are successfully provisioned + +```ruby +describe azure_service_fabric_mesh_volumes(resource_group: 'RESOURCE_GROUP').where(provisioningState: 'Succeeded') do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no Service Fabric Mesh volumes are present. + +describe azure_service_fabric_mesh_volumes(resource_group: 'RESOURCE_GROUP') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Service Fabric Mesh volume. + +describe azure_service_fabric_mesh_volumes(resource_group: 'RESOURCE_GROUP') do + it { should exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_snapshot.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_snapshot.md new file mode 100644 index 0000000000..aaac919832 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_snapshot.md @@ -0,0 +1,126 @@ ++++ +title = "azure_snapshot Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_snapshot" +identifier = "inspec/resources/azure/azure_snapshot Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_snapshot` InSpec audit resource to test the properties and configuration of an Azure snapshot. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +`resource_group` and `name` are required parameters. + +```ruby +describe azure_snapshot(resource_group: 'RESOURCE_GROUP', name: 'SNAPSHOT_NAME') do + it { should exist } +end +``` + +## Parameters + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +`name` _(required)_ +: The name of the snapshot that is being created. + +## Properties + +`id` +: The id of the snapshot. + +`name` +: The name of the snapshot. + +`type` +: The type of the snapshot. + +`location` +: The location of the snapshot. + +`properties` +: The properties of the snapshot. + +`sku` +: The sku of the snapshot. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +See the [Azure documentation](https://learn.microsoft.com/en-us/rest/api/compute/snapshots/get?tabs=HTTP) for other available properties. +Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. + +## Examples + +### Test if a snapshot is referenced with a valid name + +```ruby +describe azure_snapshot(resource_group: 'RESOURCE_GROUP', name: 'SNAPSHOT_NAME') do + it { should exist } +end +``` + +### Test if a snapshot is referenced with an invalid name + +```ruby +describe azure_snapshot(resource_group: 'RESOURCE_GROUP', name: 'SNAPSHOT_NAME') do + it { should_not exist } +end +``` + +### Test if a snapshot has the `Windows' operating system type + +```ruby +describe azure_snapshot(resource_group: 'RESOURCE_GROUP', name: 'SNAPSHOT_NAME') do + its('properties.osType') { should cmp 'Windows' } +end +``` + +### Test if the snapshot has a valid disk size + +```ruby +describe azure_snapshot(resource_group: 'RESOURCE_GROUP', name: 'SNAPSHOT_NAME') do + its('properties.diskSizeGB') { should cmp 127 } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +Use `should exist` to test for a resource that should exist. + +```ruby +describe azure_snapshot(resource_group: 'RESOURCE_GROUP', name: 'SNAPSHOT_NAME') do + it { should exist } +end +``` + +Use `should_not exist` to test for a resource that should not exist. + +```ruby +describe azure_snapshot(resource_group: 'RESOURCE_GROUP', name: 'SNAPSHOT_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_snapshots.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_snapshots.md new file mode 100644 index 0000000000..687ed55ce4 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_snapshots.md @@ -0,0 +1,113 @@ ++++ +title = "azure_snapshots Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_snapshots" +identifier = "inspec/resources/azure/azure_snapshots Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_snapshots` InSpec audit resource to test the properties and configurations of multiple Azure snapshots. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +```ruby +describe azure_snapshots do + it { should exist } +end +``` + +## Parameters + +No required parameters. + +## Properties + +`ids` +: The id of the snapshot. + +: **Field**: `id` + +`names` +: The name of the snapshot. + +: **Field**: `name` + +`types` +: The type of the snapshot. + +: **Field**: `type` + +`locations` +: The location of the snapshot. + +: **Field**: `location` + +`properties` +: The properties of the snapshot. + +: **Field**: `properties` + +`skus` +: The sku of the snapshot. + +: **Field**: `sku` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +See the [Azure documentation](https://learn.microsoft.com/en-us/rest/api/compute/snapshots/list-by-resource-group?tabs=HTTP) for other available properties. + +## Examples + +### Test if a snapshot has a valid type + +```ruby +describe azure_snapshots do + its('types') { should cmp 'Microsoft.Compute/snapshots' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + +Use `should exist` to test that a resource exists. + +```ruby +describe azure_snapshots do + it { should exist } +end +``` + +Use `should_not exist` to test that resources do not exist. + +```ruby +describe azure_snapshots do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_database.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_database.md index 6fc0e7789b..86ac17fb9b 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_database.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_database.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_sql_database Resource" parent = "inspec/resources/azure" +++ -Use the `azure_sql_database` InSpec audit resource to test properties and configuration of an Azure SQL Database. +Use the `azure_sql_database` InSpec audit resource to test the properties and configuration of an Azure SQL Database. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group`, `server_name` and `name` or the `resource_id` must be given as a parameter. +`resource_group`, `server_name`, and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_sql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do +describe azure_sql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DB_NAME') do it { should exist } end ``` + ```ruby describe azure_sql_database(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}') do it { should exist } @@ -37,30 +39,31 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `server_name` -: The name of the server on which the database resides. `serverName`. +: The name of the server on which the database resides. `name` -: Name of the SQL database to test. `MyDatabase`. +: Name of the SQL database to test. `database_name` : Alias for the `name` parameter. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}`. +: The unique resource ID. `auditing_settings_api_version` -: The endpoint api version for the `auditing_settings` property. The latest version will be used unless provided. +: The endpoint API version for the `auditing_settings` property. The latest version will be used unless provided. `threat_detection_settings_api_version` -: The endpoint api version for the `threat_detection_settings` property. The latest version will be used unless provided. +: The endpoint API version for the `threat_detection_settings` property. The latest version will be used unless provided. `encryption_settings_api_version` -: The endpoint api version for the `encryption_settings` property. The latest version will be used unless provided. +: The endpoint API version for the `encryption_settings` property. The latest version will be used unless provided. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group`, `server_name`, and `name` - `resource_group`, `server_name`, and `database_name` @@ -76,68 +79,79 @@ Either one of the parameter sets can be provided for a valid query: `threat_detection_settings` : Threat detection settings for the targeted database with [these](https://docs.microsoft.com/en-us/rest/api/sql/databasethreatdetectionpolicies/get#databasesecurityalertpolicy) properties. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/sql/databases/get#database) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/sql/databases/get#database) for other properties available. +Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test If a SQL Database is Referenced with a Valid Name.** +### Test if a SQL database is referenced with a valid name ```ruby -describe azure_sql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do +describe azure_sql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DB_NAME') do it { should exist } end ``` -**Test If a SQL Database is Referenced with an Invalid Name.** + +### Test if a SQL database is referenced with an invalid name ```ruby -describe azure_sql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do +describe azure_sql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DB_NAME') do it { should_not exist } end -``` -**Test If a SQL Database Has Transparent Data Encryption is Enabled.** +``` + +### Test if a SQL database has transparent data encryption is enabled ```ruby -describe azure_sql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do +describe azure_sql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DB_NAME') do its('encryption_settings.properties.status') { should cmp 'Enabled' } end -``` -**Test If a SQL Database Auditing is Enabled.** +``` + +### Test if a SQL database auditing is enabled ```ruby describe azure_sql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do its('auditing_settings.properties.status') { should cmp 'Enabled' } end -``` -**Test If a SQL Database Threat Detection is Enabled.** +``` + +### Test if a SQL database threat detection is enabled ```ruby -describe azure_sql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do +describe azure_sql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DB_NAME') do its('threat_detection_settings.properties.status') { should cmp 'Enabled' } end -``` +``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# If we expect a resource to always exist +# If we expect a resource to always exist. -describe azure_sql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do +describe azure_sql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DB_NAME') do it { should exist } end -# If we expect a resource to never exist +``` -describe azure_sql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do +### not_exists + +```ruby +# If we expect a resource to never exist. + +describe azure_sql_database(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME', name: 'DB_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_database_server_vulnerability_assessment.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_database_server_vulnerability_assessment.md new file mode 100644 index 0000000000..f7d9540f10 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_database_server_vulnerability_assessment.md @@ -0,0 +1,100 @@ ++++ +title = "azure_sql_database_server_vulnerability_assessment Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_sql_database_server_vulnerability_assessment" +identifier = "inspec/resources/azure/azure_sql_database_server_vulnerability_assessment Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_sql_database_server_vulnerability_assessment` InSpec audit resource to test the properties and configuration of an Azure SQL Database server vulnerability assessment. + +## Syntax + +`resource_group` and `server_name` are required parameters. + +```ruby +describe azure_sql_database_server_vulnerability_assessment(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + it { should exist } +end +``` + +## Parameters + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +`server_name` _(required)_ +: The name of the server on which the database resides. + +## Properties + +`id` +: The ID of the resource. + +`name` +: The name of the resource. The name of the vulnerability assessment is `default`. + +`type` +: The type of the resource. + +`properties.recurringScans.isEnabled` +: Recurring scans state. + +`properties.recurringScans.emailSubscriptionAdmins` +: Specifies that the schedule scan notification will be is sent to the subscription administrators. + +`properties.recurringScans.emails` +: Specifies an array of e-mail addresses to which the scan notification is sent. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +See the [Azure documentation](https://learn.microsoft.com/en-us/rest/api/sql/2020-11-01-preview/server-vulnerability-assessments/get?tabs=HTTP) for other available properties. +Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. + +## Examples + +### Test if a SQL database server vulnerability assessment has recurring scans enabled + +```ruby +describe azure_sql_database_server_vulnerability_assessment(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + its('properties.recurringScans.isEnabled') { should eq false } +end +``` + +### Verify the type of the resource. + +```ruby +describe azure_sql_database_server_vulnerability_assessment(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + its('type') { should eq 'Microsoft.Sql/servers/vulnerabilityAssessments' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exist + +The control passes if the filter returns a result. Use `should_not` if a resource should not exist. + +```ruby +describe azure_sql_database_server_vulnerability_assessment(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + it { should exist } +end +``` + +```ruby +describe azure_sql_database_server_vulnerability_assessment(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_database_server_vulnerability_assessments.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_database_server_vulnerability_assessments.md new file mode 100644 index 0000000000..a306756b5a --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_database_server_vulnerability_assessments.md @@ -0,0 +1,129 @@ ++++ +title = "azure_sql_database_server_vulnerability_assessments Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_sql_database_server_vulnerability_assessments" +identifier = "inspec/resources/azure/azure_sql_database_server_vulnerability_assessments Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_sql_database_server_vulnerability_assessments` InSpec audit resource to test the properties and configuration of multiple Azure SQL Database server vulnerability assessments. + +## Syntax + +The `resource_group` and `server_name` are required parameters. + +```ruby +describe azure_sql_database_server_vulnerability_assessments(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + it { should exist } +end +``` + +## Parameters + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +`server_name` _(required)_ +: The name of the server in which the database resides. + +## Properties + +`ids` +: The ID of the resource. + +: **Field**: `id` + +`names` +: The name of the resource. The name of the vulnerability assessment is `default`. + +: **Field**: `name` + +`types` +: The type of the resource. + +: **Field**: `type` + +`isEnabled` +: Recurring scans state. + +: **Field**: `properties.recurringScans.isEnabled` + +`emailSubscriptionAdmins` +: Specifies that the schedule scan notification will be is sent to the subscription administrators. + +: **Field**: `properties.recurringScans.emailSubscriptionAdmins` + +`emails` +: Specifies an array of e-mail addresses to which the scan notification is sent. + +: **Field**: `properties.recurringScans.emails` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Check resources are present + +````ruby +describe azure_sql_database_server_vulnerability_assessments(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + it { should exist } + its('names') { should include 'Default' } +end +```` + +### Filter the results to include only those with names that match the specified string value + +```ruby +describe azure_sql_database_server_vulnerability_assessments(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + it { should exist } +end +``` + +### Verify the types of the resource + +```ruby +describe azure_sql_database_server_vulnerability_assessments(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + its('types') { should include 'Microsoft.Sql/servers/vulnerabilityAssessments' } +``` + +### Verify whether the recurring scans are enabled or not + +```ruby +describe azure_sql_database_server_vulnerability_assessments(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + its('isEnabled') { should include false } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exist + +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + +```ruby +describe azure_sql_database_server_vulnerability_assessments(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + it { should exist } +end +``` + +```ruby +describe azure_sql_database_server_vulnerability_assessments(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_databases.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_databases.md index 8db2227601..7c8af8d53c 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_databases.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_databases.md @@ -10,21 +10,22 @@ identifier = "inspec/resources/azure/azure_sql_databases Resource" parent = "inspec/resources/azure" +++ -Use the `azure_sql_databases` InSpec audit resource to test properties and configuration of Azure SQL Databases. +Use the `azure_sql_databases` InSpec audit resource to test the properties and configuration of Azure SQL Databases. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -The `resource_group`, and `server_name` must be given as a parameter. +The `resource_group` and `server_name` are required parameters. + ```ruby -describe azure_sql_databases(resource_group: 'my-rg', server_name: 'my-server') do +describe azure_sql_databases(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do it { should exist } end ``` @@ -32,15 +33,15 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `server_name` -: The name of the server in which the database resides. `serverName`. +: The name of the server in which the database resides. ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -74,54 +75,67 @@ end : **Field**: `kind` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check Resources are Present.** +### Check resources are present ````ruby -describe azure_sql_databases(resource_group: 'my-rg', server_name: 'my-server') do +describe azure_sql_databases(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do it { should exist } its('names') { should include 'my-db' } end ```` -**Filter the Results to Include Only those with Names Match the Given String Value.** + +### Filter the results to include only those with names that match the specified string value ```ruby -describe azure_sql_databases.(resource_group: 'my-rg', server_name: 'my-server').where{ name.eql?('production-db') } do +describe azure_sql_databases.(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME').where{ name.eql?('production-db') } do it { should exist } end ``` -**Filter the Results to Include Only those with `GRS` Storage Account Type.** + +### Filter the results to include only those with 'GRS' storage account type ```ruby -describe azure_sql_databases.(resource_group: 'my-rg', server_name: 'my-server').where{ properties[:storageAccountType] == 'GRS' } do +describe azure_sql_databases.(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME').where{ properties[:storageAccountType] == 'GRS' } do it { should exist } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby -# If we expect resources to exist +# If we expect resources to exist. -describe azure_sql_databases(resource_group: 'ExampleGroup', server_name: 'my-server') do +describe azure_sql_databases(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do it { should exist } end +``` -# If we expect resources not to exist +### not_exists + +```ruby +# If we expect resources not to exist. -describe azure_sql_databases(resource_group: 'ExampleGroup', server_name: 'my-server') do +describe azure_sql_databases(resource_group: 'RESOURCE_GROUP', server_name: 'SERVER_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_managed_instance.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_managed_instance.md index f21de09053..a18b12ceee 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_managed_instance.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_managed_instance.md @@ -14,15 +14,15 @@ Use the `azure_sql_managed_instance` InSpec audit resource to test the propertie ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`name`, `resource_group` are required parameters. +`name` and`resource_group` are required parameters. ```ruby describe azure_sql_managed_instance(resource_group: 'RESOURCE_GROUP', name: 'INSTANCE_NAME') do @@ -44,9 +44,9 @@ end : Name of the Azure SQL managed instances to test. `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. -The parameter set should be provided for a valid query: `resource_group` and `name` +The parameter set that should be provided for a valid query is `resource_group` and `name`. ## Properties @@ -63,25 +63,25 @@ The parameter set should be provided for a valid query: `resource_group` and `na : Resource location. `properties` -: The properties of the SQL Managed Instance. +: The properties of the SQL-Managed Instance. `properties.minimalTlsVersion` -: Minimal TLS version. Allowed values are 'None', '1.0', '1.1', '1.2'. +: Minimal TLS version. Allowed values are `None`, `1.0`, `1.1`, and `1.2`. `properties.maintenanceConfigurationId` -: Specifies maintenance configuration id to apply to this managed instance. +: Specifies maintenance configuration ID to apply to this managed instance. `properties.provisioningState` -: Provisioning state of the SQL managed instance. +: Provisioning state of the SQL-managed instance. `sku.name` -: The name of the SKU, typically, a letter with a number code. For example, P3. +: The name of the SKU, typically a letter with a number code. For example, `P3`. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties` refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/sql/2021-02-01-preview/managed-instances/get) for other properties available. +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties` refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/sql/2021-02-01-preview/managed-instances/get) for other properties available. ## Examples -**Test that the SQL managed instances is provisioned successfully.** +### Test that the SQL managed instances are provisioned successfully ```ruby describe azure_sql_managed_instance(resource_group: 'RESOURCE_GROUP', name: 'INSTANCE_NAME') do @@ -96,11 +96,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a SQL managed instance is found, it will exist +# If a SQL-managed instance is found, it will exist. + describe azure_sql_managed_instance(resource_group: 'RESOURCE_GROUP', name: 'INSTANCE_NAME') do it { should exist } end -# if SQL managed instance is not found, it will not exist +``` + +### not_exists + +```ruby +# if SQL managed instance is not found, it will not exist. + describe azure_sql_managed_instance(resource_group: 'RESOURCE_GROUP', name: 'INSTANCE_NAME') do it { should_not exist } end @@ -108,4 +115,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="reader" %}} +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_managed_instances.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_managed_instances.md index 7f0a0ffd6f..9fd12e9540 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_managed_instances.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_managed_instances.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_sql_managed_instances Resource" parent = "inspec/resources/azure" +++ -Use the `azure_sql_managed_instances` InSpec audit resource to test the properties related to all Azure SQL managed instances within a project. +Use the `azure_sql_managed_instances` InSpec audit resource to test the properties related to all Azure SQL-managed instances within a project. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_sql_managed_instances` resource block returns all Azure SQL managed instances within a project. +An `azure_sql_managed_instances` resource block returns all Azure SQL-managed instances within a project. ```ruby describe azure_sql_managed_instances do @@ -34,7 +34,7 @@ end `resource_group` _(optional)_ -: The Azure resource group that the targeted resource resides in. +: The Azure resource group where the targeted resource resides. ## Properties @@ -54,7 +54,7 @@ end : **Field**: `type` `properties` -: A list of properties for all the SQL managed instances. +: A list of properties for all the SQL-managed instances. : **Field**: `properties` @@ -64,12 +64,12 @@ end : **Field**: `location` `provisioningStates` -: A list of provisioning states of all the SQL managed instances. +: A list of provisioning states of all the SQL-managed instances. : **Field**: `provisioningState` `minimalTlsVersions` -: A list of minimalTlsVersion for all the SQL managed instances. +: A list of minimalTlsVersion for all the SQL-managed instances. : **Field**: `minimalTlsVersion` @@ -83,7 +83,11 @@ end : **Field**: `sku_tier` -* For information on how to use filter criteria on plural resources, refer to [FilterTable usage](https://github.com/inspec/inspec/blob/master/dev-docs/filtertable-usage.md). +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples @@ -97,7 +101,7 @@ azure_sql_managed_instances(resource_group: 'RESOURCE_GROUP').names.each do |nam end ``` -**Test that there are SQL managed instances that are successfully provisioned.** +### Test that there are SQL-managed instances that are successfully provisioned ```ruby describe azure_sql_managed_instances.where(provisioningState: 'Succeeded') do @@ -107,17 +111,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no SQL Managed Instances are present +# Should not exist if no SQL-Managed Instances are present. describe azure_sql_managed_instances do it { should_not exist } end -# Should exist if the filter returns at least one SQL Managed Instances +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one SQL-Managed Instance. describe azure_sql_managed_instances do it { should exist } @@ -126,4 +137,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="reader" %}} +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_server.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_server.md index 9497686473..06215c1c98 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_server.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_server.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_sql_server Resource" parent = "inspec/resources/azure" +++ -Use the `azure_sql_server` InSpec audit resource to test properties and configuration of an Azure SQL Server. +Use the `azure_sql_server` InSpec audit resource to test the properties and configuration of an Azure SQL Server. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `name` or the `resource_id` must be given as a parameter. +`resource_group` and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_sql_server(resource_group: 'inspec-resource-group-9', name: 'example_server') do +describe azure_sql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do it { should exist } end ``` + ```ruby describe azure_sql_server(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}') do it { should exist } @@ -37,33 +39,34 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: Name of the SQL server to test. `MyServer`. +: Name of the SQL server to test. `server_name` : Alias for the `name` parameter. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}`. +: The unique resource ID. `firewall_rules_api_version` -: The endpoint api version for the `firewall_rules` property. The latest version will be used unless provided. +: The endpoint API version for the `firewall_rules` property. The latest version will be used unless provided. `auditing_settings_api_version` -: The endpoint api version for the `auditing_settings` property. The latest version will be used unless provided. +: The endpoint API version for the `auditing_settings` property. The latest version will be used unless provided. `threat_detection_settings_api_version` -: The endpoint api version for the `threat_detection_settings` property. The latest version will be used unless provided. +: The endpoint API version for the `threat_detection_settings` property. The latest version will be used unless provided. `administrators_api_version` -: The endpoint api version for the `administrators` property. The latest version will be used unless provided. +: The endpoint API version for the `administrators` property. The latest version will be used unless provided. `encryption_protector_api_version` -: The endpoint api version for the `encryption_protector` property. The latest version will be used unless provided. +: The endpoint API version for the `encryption_protector` property. The latest version will be used unless provided. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` - `resource_group` and `server_name` @@ -88,35 +91,38 @@ Either one of the parameter sets can be provided for a valid query: `sku` : The SKU (pricing tier) of the server. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/sql/servers/get#server) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/sql/servers/get#server) for other properties available. +Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test If a SQL Server is Referenced with a Valid Name.** +### Test if a SQL server is referenced with a valid name ```ruby -describe azure_sql_server(resource_group: 'my-rg', name: 'sql-server-1') do +describe azure_sql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do it { should exist } end ``` -**Test If a SQL Server is Referenced with an Invalid Name.** + +### Test if a SQL server is referenced with an invalid name ```ruby -describe azure_sql_server(resource_group: 'my-rg', name: 'i-dont-exist') do +describe azure_sql_server(resource_group: 'RESOURCE_GROUP', name: 'i-dont-exist') do it { should_not exist } end -``` -**Test If a SQL Server Has Firewall Rules Set.** +``` + +### Test if a SQL server has firewall rules set ```ruby -describe azure_sql_server(resource_group: 'my-rg', name: 'my-server') do +describe azure_sql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do its('firewall_rules') { should_not be_empty } end -``` -**Test a SQL Server's Location and Kind.** +``` + +### Test a SQL server's location and kind ```ruby describe azure_sql_server(resource_id: '/subscriptions/.../my-server') do @@ -124,10 +130,11 @@ describe azure_sql_server(resource_id: '/subscriptions/.../my-server') do its('location') { should cmp 'westeurope' } end ``` -**Test a SQL Server's Auditing Settings.** + +### Test a SQL server's auditing settings ```ruby -describe azure_sql_server(resource_group: 'my-rg', name: 'my-server') do +describe azure_sql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do its('auditing_settings.properties.state') { should cmp 'Disabled' } its('auditing_settings.properties.retentionDays') { should be 0 } its('auditing_settings.properties.isStorageSecondaryKeyInUse') { should be false } @@ -137,23 +144,30 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# If we expect a resource to always exist +# If we expect a resource to always exist. -describe azure_sql_server(resource_group: 'my-rg', server_name: 'server-name-1') do +describe azure_sql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do it { should exist } end -# If we expect a resource to never exist +``` + +### not_exists + +```ruby +# If we expect a resource to never exist. -describe azure_sql_server(resource_group: 'my-rg', server_name: 'server-name-1') do +describe azure_sql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_servers.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_servers.md index b23c3a745b..e30827a77b 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_servers.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_servers.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_sql_servers Resource" parent = "inspec/resources/azure" +++ -Use the `azure_sql_servers` InSpec audit resource to test properties and configuration of multiple Azure SQL Servers. +Use the `azure_sql_servers` InSpec audit resource to test the properties and configuration of multiple Azure SQL Servers. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_sql_servers` resource block returns all Azure SQL Servers, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_sql_servers` resource block returns all Azure SQL Servers, either within a resource group (if provided) or an entire subscription. + ```ruby describe azure_sql_servers do it { should exist } end ``` -or + +Or + ```ruby -describe azure_sql_servers(resource_group: 'my-rg') do +describe azure_sql_servers(resource_group: 'RESOURCE_GROUP') do it { should exist } end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -83,46 +86,56 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check a Specific SQL Server is Present.** +### Checks if a specific SQL server is present ```ruby describe azure_sql_servers do its('names') { should include 'my-server-name' } end ``` -**Filters the Results to Include Only Those Servers which Include the Given Name (Client Side Filtering).** + +### Filters the results to include only those servers that have the specified name (Client Side Filtering) ```ruby describe azure_sql_servers.where{ name.include?('production') } do it { should exist } end ``` -**Filters the Results to Include Only Those Servers which Reside in a Given Location (Client Side Filtering).** + +### Filters the results to include only those servers that reside in a specified location (Client Side Filtering) ```ruby describe azure_sql_servers.where{ location.eql?('westeurope') } do it { should exist } end -``` -**Filters the Results to Include Only Those Servers which Reside in a Given Location and Include the Given Name (Server Side Filtering - Recommended).** +``` + +### Filters the results to include only those servers that reside in a specified location and have the specified name (Server Side Filtering - Recommended) ```ruby describe azure_generic_resources(resource_provider: 'Microsoft.Sql/servers', substring_of_name: 'production', location: 'westeurope') do - it {should exist} + it {should exist} end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby describe azure_sql_servers do it { should exist } @@ -131,4 +144,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine.md index 60f4e47c50..3829730c2a 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_sql_virtual_machine Resource" parent = "inspec/resources/azure" +++ -Use the `azure_sql_virtual_machine` Chef InSpec audit resource to test properties of an Azure SQL virtual machine. +Use the `azure_sql_virtual_machine` Chef InSpec audit resource to test the properties of an Azure SQL virtual machine. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -44,7 +44,7 @@ end `resource_group` _(required)_ -: Azure resource group that the targeted resource resides in. | +: Azure resource group where the targeted resource resides. ## Properties @@ -66,14 +66,13 @@ end `properties.provisioningState` : State of the resource. +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). - -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/sqlvm/sql-virtual-machines/get) for other properties available. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/get) for other properties available. ## Examples -**Test that the SQL virtual machine is provisioned successfully.** +### Test that the SQL virtual machine is provisioned successfully ```ruby describe azure_sql_virtual_machine(resource_group: 'RESOURCE_GROUP', name: 'SQL_VM_NAME') do @@ -88,12 +87,17 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a SQL Virtual Machine is found it will exist +# If a SQL Virtual Machine is found, it will exist. describe azure_sql_virtual_machine(resource_group: 'RESOURCE_GROUP', name: 'SQL_VM_NAME') do it { should exist } end -# if SQL Virtual Machine is not found it will not exist +``` + +### not_exists + +```ruby +# If SQL Virtual Machine is not found, it will not exist. describe azure_sql_virtual_machine(resource_group: 'RESOURCE_GROUP', name: 'SQL_VM_NAME') do it { should_not exist } @@ -102,4 +106,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="reader" %}} +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_group.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_group.md index 93aec27272..2e99c34bd1 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_group.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_group.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_sql_virtual_machine_group Resource" parent = "inspec/resources/azure" +++ -Use the `azure_sql_virtual_machine_group` InSpec audit resource to test properties related to an Azure SQL virtual machine group. +Use the `azure_sql_virtual_machine_group` InSpec audit resource to test the properties related to an Azure SQL virtual machine group. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`name`, `resource_group` are required parameters. +`name` and `resource_group` are required parameters. ```ruby describe azure_sql_virtual_machine_group(resource_group: 'RESOURCE_GROUP', name: 'SQL_VIRTUAL_MACHINE_GROUP') do @@ -46,12 +46,12 @@ end `resource_group` _(required)_ -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. ## Properties `id` -: Resource Id. +: Resource ID. `name` : Resource name. @@ -68,14 +68,13 @@ end `properties.provisioningState` : State of the resource. +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). - -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/sqlvm/sql-virtual-machine-groups/get) for other properties available. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/sqlvm/2021-11-01-preview/sql-virtual-machine-groups/get) for other properties available. ## Examples -**Test that the SQL virtual machine group is provisioned successfully.** +### Test that the SQL virtual machine group is provisioned successfully ```ruby describe azure_sql_virtual_machine_group(resource_group: 'RESOURCE_GROUP', name: 'SQL_VIRTUAL_MACHINE_GROUP') do @@ -90,12 +89,17 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a SQL virtual machine group is found it will exist +# If a SQL virtual machine group is found, it will exist. describe azure_sql_virtual_machine_group(resource_group: 'RESOURCE_GROUP', name: 'SQL_VIRTUAL_MACHINE_GROUP') do it { should exist } end -# if SQL virtual machine group is not found it will not exist +``` + +### not_exists + +```ruby +# If SQL virtual machine group is not found, it will not exist. describe azure_sql_virtual_machine_group(resource_group: 'RESOURCE_GROUP', name: 'SQL_VIRTUAL_MACHINE_GROUP') do it { should_not exist } @@ -104,4 +108,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="reader" %}} +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_group_availability_listener.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_group_availability_listener.md index 9bd1296814..479ff15350 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_group_availability_listener.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_group_availability_listener.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_sql_virtual_machine_group_availabilit parent = "inspec/resources/azure" +++ -Use the `azure_sql_virtual_machine_group_availability_listener` InSpec audit resource to test properties related to an Azure SQL virtual machine group availability listener. +Use the `azure_sql_virtual_machine_group_availability_listener` InSpec audit resource to test the properties related to an Azure SQL virtual machine group availability listener. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -43,11 +43,11 @@ end `resource_group` _(required)_ -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `sql_virtual_machine_group_name` _(required)_ -: The Azure SQL virtual machine group name +: The Azure SQL virtual machine group name. ## Properties @@ -66,14 +66,13 @@ end `properties.provisioningState` : State of the resource. - -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/servicefabric/sfmeshrp-api-application_get) for other properties available. ## Examples -**Test that the SQL virtual machine group availability listener is provisioned successfully.** +### Test that the SQL virtual machine group availability listener is provisioned successfully ```ruby describe azure_sql_virtual_machine_group_availability_listener(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME', name: 'AVAILABILITY_LISTENER_NAME') do @@ -88,12 +87,17 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a SQL virtual machine group availability listener is found it will exist +# If a SQL virtual machine group availability listener is found, it will exist. describe azure_sql_virtual_machine_group_availability_listener(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME', name: 'AVAILABILITY_LISTENER_NAME') do it { should exist } end -# if SQL virtual machine group availability listener is not found it will not exist +``` + +### not_exists + +```ruby +# if SQL virtual machine group availability listener is not found, it will not exist describe azure_sql_virtual_machine_group_availability_listener(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME', name: 'AVAILABILITY_LISTENER_NAME') do it { should_not exist } @@ -102,4 +106,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="reader" %}} +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_group_availability_listeners.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_group_availability_listeners.md index 255e190cf2..11cf3ac011 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_group_availability_listeners.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_group_availability_listeners.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_sql_virtual_machine_group_availabilit parent = "inspec/resources/azure" +++ -Use the `azure_sql_virtual_machine_group_availability_listeners` InSpec audit resource to test properties related to all Azure SQL virtual machine group availability listeners. +Use the `azure_sql_virtual_machine_group_availability_listeners` InSpec audit resource to test the properties related to all Azure SQL virtual machine group availability listeners. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -34,11 +34,11 @@ end `resource_group` _(required)_ -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `sql_virtual_machine_group_name` _(required)_ -: Azure SQL virtual machine group name +: Azure SQL virtual machine group name. ## Properties @@ -67,11 +67,15 @@ end : **Field**: `provisioningState` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through SQL virtual machine group availability listeners by their names.** +### Loop through SQL virtual machine group availability listeners by their names ```ruby azure_sql_virtual_machine_group_availability_listeners(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME').names.each do |name| @@ -81,7 +85,7 @@ azure_sql_virtual_machine_group_availability_listeners(resource_group: 'RESOURCE end ``` -**Test that there are SQL virtual machine group availability listeners that are successfully provisioned.** +### Test that there are SQL virtual machine group availability listeners that are successfully provisioned ```ruby describe azure_sql_virtual_machine_group_availability_listeners(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME').where(provisioningState: 'Succeeded') do @@ -91,17 +95,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no SQL virtual machine group availability listeners are present +# Should not exist if no SQL virtual machine group availability listeners are present. describe azure_sql_virtual_machine_group_availability_listeners(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME') do it { should_not exist } end -# Should exist if the filter returns at least one SQL virtual machine group availability listeners +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one SQL virtual machine group availability listener. describe azure_sql_virtual_machine_group_availability_listeners(resource_group: 'RESOURCE_GROUP', sql_virtual_machine_group_name: 'SQL_VIRTUAL_MACHINE_GROUP_NAME') do it { should exist } @@ -110,4 +121,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="reader" %}} +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_groups.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_groups.md index dd3653d1a7..efb37b6e59 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_groups.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machine_groups.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_sql_virtual_machine_groups Resource" parent = "inspec/resources/azure" +++ -Use the `azure_sql_virtual_machine_groups` InSpec audit resource to test properties related to all Azure SQL virtual machine groups. +Use the `azure_sql_virtual_machine_groups` InSpec audit resource to test the properties related to all Azure SQL virtual machine groups. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_sql_virtual_machine_groups` resource block returns all Azure SQL Virtual Machine Groups. +An `azure_sql_virtual_machine_groups` resource block returns all Azure SQL Virtual Machine groups. ```ruby describe azure_sql_virtual_machine_groups do @@ -34,7 +34,7 @@ end `resource_group` _(optional)_ -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. ## Properties @@ -68,11 +68,15 @@ end : **Field**: `provisioningState` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through SQL virtual machine groups by their names.** +### Loop through SQL virtual machine groups by their names ```ruby azure_sql_virtual_machine_groups(resource_group: 'RESOURCE_GROUP').names.each do |name| @@ -82,7 +86,7 @@ azure_sql_virtual_machine_groups(resource_group: 'RESOURCE_GROUP').names.each do end ``` -**Test that there are SQL virtual machine groups that are successfully provisioned.** +### Test that there are SQL virtual machine groups that are successfully provisioned ```ruby describe azure_sql_virtual_machine_groups(resource_group: 'RESOURCE_GROUP').where(provisioningState: 'Succeeded') do @@ -92,17 +96,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no SQL Virtual Machine Groups are present +# Should not exist if no SQL Virtual Machine Groups are present. describe azure_sql_virtual_machine_groups(resource_group: 'RESOURCE_GROUP') do it { should_not exist } end -# Should exist if the filter returns at least one SQL Virtual Machine Groups +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one SQL Virtual Machine group. describe azure_sql_virtual_machine_groups(resource_group: 'RESOURCE_GROUP') do it { should exist } @@ -111,4 +122,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="reader" %}} +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machines.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machines.md index cdc0ea3db2..e1a5d6bfd7 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machines.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_sql_virtual_machines.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_sql_virtual_machines Resource" parent = "inspec/resources/azure" +++ -Use the `azure_sql_virtual_machines` InSpec audit resource to test properties of all Azure SQL virtual machines. +Use the `azure_sql_virtual_machines` InSpec audit resource to test the properties of all Azure SQL virtual machines. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -34,7 +34,7 @@ end `resource_group` _(optional)_ -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. ## Properties @@ -44,7 +44,7 @@ end : **Field**: `id` `names` -: A list of resource Names. +: A list of resource names. : **Field**: `name` @@ -68,11 +68,15 @@ end : **Field**: `provisioningState` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through SQL virtual machines by their names.** +### Loop through SQL virtual machines by their names ```ruby azure_sql_virtual_machines(resource_group: 'RESOURCE_GROUP').names.each do |name| @@ -82,7 +86,7 @@ azure_sql_virtual_machines(resource_group: 'RESOURCE_GROUP').names.each do |name end ``` -**Test that there are SQL virtual machines that are successfully provisioned.** +### Test that there are SQL virtual machines that are successfully provisioned ```ruby describe azure_sql_virtual_machines(resource_group: 'RESOURCE_GROUP').where(provisioningState: 'Succeeded') do @@ -92,17 +96,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no SQL virtual machines are present +# Should not exist if no SQL virtual machines are present. describe azure_sql_virtual_machines(resource_group: 'RESOURCE_GROUP') do it { should_not exist } end -# Should exist if the filter returns at least one SQL virtual machines +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one SQL virtual machine. describe azure_sql_virtual_machines(resource_group: 'RESOURCE_GROUP') do it { should exist } @@ -111,4 +122,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="reader" %}} +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_account.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_account.md index 507f5ac058..d736785fca 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_account.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_account.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_storage_account Resource" parent = "inspec/resources/azure" +++ -Use the `azure_storage_account` InSpec audit resource to test properties related to an Azure Storage Account. +Use the `azure_storage_account` InSpec audit resource to test the properties related to an Azure Storage account. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_storage_account` resource block identifies an Azure storage account by `name` and `resource_group` or the `resource_id`. +An `azure_storage_account` resource block identifies an Azure storage account by `name` and `resource_group`, or the `resource_id`. + ```ruby -describe azure_storage_account(resource_group: 'rg', name: 'sa') do +describe azure_storage_account(resource_group: 'RESOURCE_GROUP', name: 'NAME') do it { should exist } end ``` + ```ruby describe azure_storage_account(resource_id: '/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}') do it { should exist } @@ -37,24 +39,23 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: The name of the storage account within the specified resource group. `accountName`. +: The name of the storage account within the specified resource group. `resource_id` -: The unique resource ID. `/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}`. +: The unique resource ID. `activity_log_alert_api_version` -: The activity log alerts endpoint api version used in `have_recently_generated_access_key` matcher. The latest version will be used unless provided. +: The activity log alerts endpoint API version used in the `have_recently_generated_access_key` matcher. The latest version will be used unless provided. `storage_service_endpoint_api_version` -: The storage service endpoint api version. `2019-12-12` wil be used unless provided. +: The storage service endpoint API version. `2019-12-12` will be used unless provided. `resource_data` : In-memory cached Azure Network security group data. Passing data to this parameter can increase performance since it avoids multiple network calls to the same Azure resource. When provided, it binds the values directly to the resource. Data passed to the `resource_data` parameter could be stale. It is the user's responsibility to refresh the data. - Pass one of the following parameter sets for a valid query: - `resource_id` @@ -67,83 +68,89 @@ Pass one of the following parameter sets for a valid query: : Lists all of the queues in a given storage account. See [here](https://docs.microsoft.com/en-us/rest/api/storageservices/list-queues1) for more. `queue_properties*` -: gets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. See [here](https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties) for more. +: Gets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. See [here](https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties) for more. `blobs*` : Lists all of the blob containers in a given storage account. See [here](https://docs.microsoft.com/en-us/rest/api/storageservices/list-containers2) for more. `blob_properties*` -: gets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. See [here](https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties) for more. +: Gets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. See [here](https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties) for more. `table_properties*` -: gets the properties of a storage account’s Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. See [here](https://docs.microsoft.com/en-us/rest/api/storageservices/get-table-service-properties) for more. +: Gets the properties of a storage account’s Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. See [here](https://docs.microsoft.com/en-us/rest/api/storageservices/get-table-service-properties) for more. *: Note that the Azure endpoints return data in XML format; however, they will be converted to Azure Resource Probe to make the properties accessible via dot notation. -The property names will be in snake case, `propety_name`. Therefore, `` can be tested via `its('enumeration_results.service_endpoint)`. -The property names will be in snake case, `propety_name`. Therefore, `` can be tested via `its('enumeration_results.service_endpoint)`. +The property names will be in snake case, `property_name`. Therefore, `` can be tested via `its('enumeration_results.service_endpoint)`. + +The property names will be in snake case, `property_name`. Therefore, `` can be tested via `its('enumeration_results.service_endpoint)`. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/storagerp/storageaccounts/getproperties#storageaccount) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/storagerp/storageaccounts/getproperties#storageaccount) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test the Primary Endpoints.** +### Test the primary endpoints ```ruby -describe azure_storage_account(resource_group: 'rg', name: 'mysa') do +describe azure_storage_account(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('properties.primaryEndpoints.blob') { should cmp 'https://mysa.blob.core.windows.net/' } its('properties.primaryEndpoints.queue') { should cmp 'https://mysa.queue.core.windows.net/' } its('properties.primaryEndpoints.table') { should cmp 'https://mysa.table.core.windows.net/' } its('properties.primaryEndpoints.file') { should cmp 'https://mysa.file.core.windows.net/' } end ``` -**Verify that Only HTTPs is Supported.** + +### Verify that only HTTPS is supported ```ruby -describe azure_storage_account(resource_group: 'rg', name: 'mysa') do +describe azure_storage_account(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('properties.supportsHttpsTrafficOnly') { should be true } end ``` -**Test Queues Service Endpoint.** + +### Test queues service endpoint ```ruby -describe azure_storage_account(resource_group: 'rg', name: 'mysa') do +describe azure_storage_account(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('queues.enumeration_results.service_endpoint') { should cmp 'https://mysa.queue.core.windows.net/' } end ``` -**Test Blobs Service Endpoint.** + +### Test Blobs service endpoint ```ruby -describe azure_storage_account(resource_group: 'rg', name: 'mysa') do +describe azure_storage_account(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('blobs.enumeration_results.service_endpoint') { should cmp 'https://mysa.blob.core.windows.net/' } end ``` -**Test Queue Properties Logging Version.** + +### Test queue properties logging version ```ruby -describe azure_storage_account(resource_group: 'rg', name: 'mysa') do +describe azure_storage_account(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('queue_properties.logging.version') { should cmp '1.0' } end ``` -**Test Blob Properties Logging Version.** + +### Test Blob properties logging version ```ruby -describe azure_storage_account(resource_group: 'rg', name: 'mysa') do +describe azure_storage_account(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('blob_properties.logging.version') { should cmp '1.0' } end ``` -**Test Table Properties Logging Version.** + +### Test table properties logging version ```ruby -describe azure_storage_account(resource_group: 'rg', name: 'mysa') do +describe azure_storage_account(resource_group: 'RESOURCE_GROUP', name: 'NAME') do its('table_properties.logging.version') { should cmp '1.0' } end ``` -**Loop through all storage accounts and test a blob service endpoint exists from already cached data.** +### Loop through all storage accounts and test a blob service endpoint exists from already cached data ```ruby azure_storage_accounts.entries.each do |azure_storage_account_data| @@ -160,8 +167,9 @@ This InSpec audit resource has the following special matchers. For a full list o ### have_encryption_enabled Test if encryption is enabled. + ```ruby -describe azure_storage_account(resource_group: 'rg', name: 'mysa') do +describe azure_storage_account(resource_group: 'RESOURCE_GROUP', name: 'NAME') do it { should have_encryption_enabled } end ``` @@ -169,27 +177,33 @@ end ### have_recently_generated_access_key Test if an access key has been generated within the last **90** days. + ```ruby -describe azure_storage_account(resource_group: 'rg', name: 'mysa') do +describe azure_storage_account(resource_group: 'RESOURCE_GROUP', name: 'NAME') do it { should have_recently_generated_access_key } end ``` + ### exists ```ruby -# If we expect the resource to always exist +# If we expect the resource to always exist. -describe azure_storage_account(resource_group: 'rg', name: 'mysa') do +describe azure_storage_account(resource_group: 'RESOURCE_GROUP', name: 'NAME') do it { should exist } end +``` -# If we expect the resource to never exist +### not_exists + +```ruby +# If we expect the resource to never exist. -describe azure_storage_account(resource_group: 'rg', name: 'mysa') do +describe azure_storage_account(resource_group: 'RESOURCE_GROUP', name: 'NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="reader" %}} +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_account_blob_container.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_account_blob_container.md index 7bf4d5b07f..b50c15b1f7 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_account_blob_container.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_account_blob_container.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_storage_account_blob_container Resour parent = "inspec/resources/azure" +++ -Use the `azure_storage_account_blob_container` InSpec audit resource to test properties related to a Blob Container in an Azure Storage Account. +Use the `azure_storage_account_blob_container` InSpec audit resource to test the properties related to a Blob Container in an Azure Storage account. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group`, `storage_account_name` and `name` or the `resource_id` must be given as a parameter. +`resource_group`, `storage_account_name`, and `name` or the `resource_id` are required parameters. + ```ruby -describe azure_storage_account_blob_container(resource_group: 'rg', storage_account_name: 'production', name: 'logs') do +describe azure_storage_account_blob_container(resource_group: 'RESOURCE_GROUP', storage_account_name: 'ACCOUNT_NAME', name: 'LOGS') do it { should exist } end ``` + ```ruby describe azure_storage_account_blob_container(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}') do it { should exist } @@ -37,21 +39,22 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `storage_account_name` -: The name of the storage account within the specified resource group. `accountName`. +: The name of the storage account within the specified resource group. `name` -: The name of the blob container within the specified storage account. `containerName`. +: The name of the blob container within the specified storage account. `blob_container_name` : Alias for the `name` parameter. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group`, `storage_account_name` and `name` - `resource_group`, `storage_account_name` and `blob_container_name` @@ -59,7 +62,7 @@ Either one of the parameter sets can be provided for a valid query: ## Properties `properties.deleted` -: Indicates whether the blob container was deleted. +: Indicates whether the Blob Container was deleted. `properties.lastModifiedTime` : Returns the date and time the container was last modified. @@ -70,35 +73,36 @@ Either one of the parameter sets can be provided for a valid query: `properties.publicAccess` : Specifies whether data in the container may be accessed publicly and the level of access. See [here](https://docs.microsoft.com/en-us/rest/api/storagerp/blobcontainers/get#publicaccess) for valid values. -For properties applicable to all resources, such as `type`, `tags`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `tags`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/storagerp/blobcontainers/get#blobcontainer) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/storagerp/blobcontainers/get#blobcontainer) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test if a Blob Container is Deleted.** +### Test if a Blob Container is deleted ```ruby -describe azure_storage_account_blob_container(resource_group: 'rg', storage_account_name: 'default', name: 'logs') do +describe azure_storage_account_blob_container(resource_group: 'RESOURCE_GROUP', storage_account_name: 'DEFAULT', name: 'LOGS') do its('properties.deleted') { should be true } end ``` -**Ensure that the Blob Container is private.** + +### Ensure that the Blob Container is private ```ruby -describe azure_storage_account_blob_container(resource_group: 'rg', storage_account_name: 'production', name: 'logs') do +describe azure_storage_account_blob_container(resource_group: 'RESOURCE_GROUP', storage_account_name: 'PRODUCTION', name: 'LOGS') do its('properties') { should have_attributes(publicAccess: 'None') } end ``` -**Loop through Resources via `resource_id`.** + +### Loop through resources via 'resource_id' ```ruby -azure_storage_account_blob_containers.(resource_group: 'rg', storage_account_name: 'production').ids.each do |id| +azure_storage_account_blob_containers.(resource_group: 'RESOURCE_GROUP', storage_account_name: 'PRODUCTION').ids.each do |id| describe azure_storage_account_blob_container(resource_id: id) do its('properties') { should have_attributes(publicAccess: 'None') } end -end +end ``` ## Matchers @@ -108,19 +112,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect the resource to always exist +# If we expect the resource to always exist. -describe azure_storage_account_blob_container(resource_group: 'rg', storage_account_name: 'production', name: 'logs') do +describe azure_storage_account_blob_container(resource_group: 'RESOURCE_GROUP', storage_account_name: 'PRODUCTION', name: 'LOGS') do it { should exist } end +``` -# If we expect the resource to never exist +### not_exists + +```ruby +# If we expect the resource to never exist. -describe azure_storage_account_blob_container(resource_group: 'rg', storage_account_name: 'production', name: 'logs') do +describe azure_storage_account_blob_container(resource_group: 'RESOURCE_GROUP', storage_account_name: 'PRODUCTION', name: 'LOGS') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_account_blob_containers.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_account_blob_containers.md index 18df125c0d..b093a64ac5 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_account_blob_containers.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_account_blob_containers.md @@ -10,21 +10,22 @@ identifier = "inspec/resources/azure/azure_storage_account_blob_containers Resou parent = "inspec/resources/azure" +++ -Use the `azure_storage_account_blob_containers` InSpec audit resource to test properties and configuration of Blob Containers within an Azure Storage Account. +Use the `azure_storage_account_blob_containers` InSpec audit resource to test the properties and configuration of Blob Containers within an Azure Storage Account. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -The `resource_group`, and `storage_account_name` must be given as a parameter. +The `resource_group` and `storage_account_name` are required parameters. + ```ruby -describe azurerm_storage_account_blob_containers(resource_group: 'rg', storage_account_name: 'production') do +describe azurerm_storage_account_blob_containers(resource_group: 'RESOURCE_GROUP', storage_account_name: 'PRODUCTION') do its('names') { should include 'my-container'} end ``` @@ -32,15 +33,15 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `storage_account_name` -: The name of the storage account within the specified resource group. `accountName`. +: The name of the storage account within the specified resource group. ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -64,35 +65,44 @@ end : **Field**: `etag` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check If a Specific Container Exists.** +### Check if a specific container exists ```ruby -describe azurerm_storage_account_blob_containers(resource_group: 'rg', storage_account_name: 'production') do +describe azurerm_storage_account_blob_containers(resource_group: 'RESOURCE_GROUP', storage_account_name: 'PRODUCTION') do its('names') { should include('my-container') } end ``` -**exists.** +### exists + +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. ```ruby -**If we expect at least one resource to exists on a specified account.** +**If we expect at least one resource to exist on a specified account.** -describe azurerm_storage_account_blob_containers(resource_group: 'rg', storage_account_name: 'production') do +describe azurerm_storage_account_blob_containers(resource_group: 'RESOURCE_GROUP', storage_account_name: 'PRODUCTION') do it { should exist } end +``` + +### not_exists -**If we expect not to exist any containers on a specified account.** +```ruby +**If we expect not to exist containers on a specified account.** -describe azurerm_storage_account_blob_containers(resource_group: 'rg', storage_account_name: 'production') do +describe azurerm_storage_account_blob_containers(resource_group: 'RESOURCE_GROUP', storage_account_name: 'PRODUCTION') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_accounts.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_accounts.md index ed4df839cb..2fe7aea496 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_accounts.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_storage_accounts.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_storage_accounts Resource" parent = "inspec/resources/azure" +++ -Use the `azure_storage_accounts` InSpec audit resource to test properties and configuration of multiple Azure Storage Accounts. +Use the `azure_storage_accounts` InSpec audit resource to test the properties and configuration of multiple Azure Storage accounts. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_storage_accounts` resource block returns all Azure storape accounts, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_storage_accounts` resource block returns all Azure storage accounts, either within a resource group (if provided) or an entire subscription. + ```ruby describe azure_storage_accounts do #... end ``` -or + +Or + ```ruby -describe azure_storage_accounts(resource_group: 'my-rg') do +describe azure_storage_accounts(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -72,40 +75,50 @@ end : A list of all properties of all the resources. : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check If a Specific Storage Account Exists.** +### Check if a specific storage account exists ```ruby -describe azurerm_storage_accounts(resource_group: 'rg') do +describe azurerm_storage_accounts(resource_group: 'RESOURCE_GROUP') do its('names') { should include('mysa') } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby -# If we expect at least one account to exist in a resource group +# If we expect at least one account to exist in a resource group. -describe azure_storage_accounts(resource_group: 'rg') do +describe azure_storage_accounts(resource_group: 'RESOURCE_GROUP') do it { should exist } end +``` -# If we expect no storage accounts to exist in a resource group +### not_exists -describe azure_storage_accounts(resource_group: 'rg') do +```ruby +# If we expect no storage accounts to exist in a resource group. + +describe azure_storage_accounts(resource_group: 'RESOURCE_GROUP') do it { should_not exist } end - ``` ## Azure Permissions -{{% azure_permissions_service_principal role="reader" %}} +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_streaming_analytics_function.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_streaming_analytics_function.md index a4fab0f79e..fc95d178f9 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_streaming_analytics_function.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_streaming_analytics_function.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_streaming_analytics_function Resource parent = "inspec/resources/azure" +++ -Use the `azure_streaming_analytics_function` InSpec audit resource to test properties and configuration of an Azure streaming analytics function. +Use the `azure_streaming_analytics_function` InSpec audit resource to test the properties and configuration of an Azure Streaming Analytics function. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group`,`job_name/name` and `function_name` are required parameters. +`resource_group`,`job_name/name`, and `function_name` are required parameters. ```ruby describe azure_streaming_analytics_function(resource_group: 'RESOURCE_GROUP', job_name: 'JOB_NAME', function_name: 'FUNCTION_NAME') do @@ -33,7 +33,7 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `job_name` : Name of the job. @@ -57,16 +57,14 @@ All three parameters are required for a valid query. `etag` : The current entity tag for the function. - - -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/streamanalytics/) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test that a Resource Group has the Specified type.** +### Test that a resource group has the specified type ```ruby describe azure_streaming_analytics_function(resource_group: 'RESOURCE_GROUP', job_name: 'JOB_NAME', function_name: 'FUNCTION_NAME') do @@ -78,9 +76,11 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -### Test Streaming function to ensure it's using Javascript UDF +This resource has the following special matchers. + +### Test streaming function to ensure it's using Javascript UDF ```ruby describe azure_streaming_analytics_function(resource_group: 'RESOURCE_GROUP', job_name: 'JOB_NAME', function_name: 'FUNCTION_NAME') do @@ -90,7 +90,7 @@ end ### exists -If we expect a resource to always exist: +If we expect a resource to always exist. ```ruby describe azure_streaming_analytics_function(resource_group: 'RESOURCE_GROUP', job_name: 'JOB_NAME', function_name: 'FUNCTION_NAME') do @@ -98,7 +98,9 @@ describe azure_streaming_analytics_function(resource_group: 'RESOURCE_GROUP', jo end ``` -If we expect a resource to never exist: +### not_exists + +If we expect a resource to never exist. ```ruby describe azure_streaming_analytics_function(resource_group: 'RESOURCE_GROUP', job_name: 'JOB_NAME', function_name: 'FUNCTION_NAME') do @@ -108,4 +110,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_streaming_analytics_functions.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_streaming_analytics_functions.md index 8bcea69b77..ed641eb65e 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_streaming_analytics_functions.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_streaming_analytics_functions.md @@ -10,19 +10,19 @@ identifier = "inspec/resources/azure/azure_streaming_analytics_functions Resourc parent = "inspec/resources/azure" +++ -Use the `azure_streaming_analytics_functions` InSpec audit resource to test properties and configuration of multiple Azure streaming analytics functions. +Use the `azure_streaming_analytics_functions` InSpec audit resource to test the properties and configuration of multiple Azure Streaming Analytics functions. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_streaming_analytics_functions` resource block returns all functions under a job. +An `azure_streaming_analytics_functions` resource block returns all functions under a job. ```ruby describe azure_streaming_analytics_functions(resource_group: "RESOURCE_GROUP", job_name: "AZURE_STREAMING_JOB_NAME") do @@ -34,7 +34,7 @@ end `resource_group` _(required)_ -: Azure resource group that the targeted resource resides in. +: Azure resource group where the targeted resource resides. `job_name` _(required)_ @@ -43,7 +43,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -63,13 +63,17 @@ end : **Field**: `properties` Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/streamanalytics/) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test that the names should be an array.** +### Test that the names should be an array ```ruby describe azure_streaming_analytics_functions(resource_group: "RESOURCE_GROUP", job_name: "AZURE_STREAMING_JOB_NAME") do @@ -80,17 +84,22 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. +The control passes if the filter returns at least one result. + ```ruby describe azure_streaming_analytics_functions(resource_group: "RESOURCE_GROUP", job_name: "AZURE_STREAMING_JOB_NAME") do it { should exist } end ``` +### not_exists + Use `should_not` if you expect zero matches. ```ruby @@ -101,4 +110,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subnet.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subnet.md index c709c845fb..71e0c343b5 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subnet.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subnet.md @@ -10,130 +10,26 @@ identifier = "inspec/resources/azure/azure_subnet Resource" parent = "inspec/resources/azure" +++ -Use the `azure_subnet` InSpec audit resource to test properties related to a subnet for a given virtual network. +Use the `azure_subnet` InSpec audit resource to test the properties related to a subnet for a given virtual network. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group`, `vnet` and `name` or the `resource_id` must be given as a parameter. -```ruby -describe azure_subnet(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do - it { should exist } -end -``` -```ruby -describe azure_subnet(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualNetworks/{vnName}/subnets/{subnetName}') do - it { should exist } -end -``` - -## Parameters - -`resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. - -`vnet` -: Name of the Azure virtual network that the subnet is created in. `MyVNetName`. - -`name` -: Name of the Azure subnet to test. `MySubnetName`. - -`resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualNetworks/{vnName}/subnets/{subnetName}`. - -Either one of the parameter sets can be provided for a valid query: -- `resource_id` -- `resource_group`, `vnet` and `name` - -## Parameters - -| Property | Description | -|----------|-------------| -| address_prefix | The address prefix for the subnet. `its('address_prefix') { should eq "x.x.x.x/x" }` | -| nsg | The network security group attached to the subnet. `its('nsg') { should eq 'MyNetworkSecurityGroupName' }` | - -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). - -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/subnets/get#subnet) for other properties available. -Any property in the response may be accessed with the key names separated by dots (`.`). - -## Examples - -**Ensure that the Subnets Address Prefix is Configured As Expected.** +`resource_group`, `vnet`, and `name`, or the `resource_id` are required parameters. ```ruby -describe azure_subnet(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do - its('address_prefix') { should eq '192.168.0.0/24' } -end -``` -**Ensure that the Subnet is Attached to the Right Network Security Group.** - -```ruby -describe azure_subnet(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do - its('nsg') { should eq 'NetworkSecurityGroupName'} -end -``` - -## Matchers - -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). - -### exists - -```ruby -# If a subnet is found it will exist - -describe azure_subnet(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do +describe azure_subnet(resource_group: 'RESOURCE_GROUP', vnet: 'VNET_NAME', name: 'SUBNET_NAME') do it { should exist } end - -# subnets that aren't found will not exist -describe azure_subnet(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'DoesNotExist') do - it { should_not exist } -end ``` -## Azure Permissions - -{{% azure_permissions_service_principal role="contributor" %}} - -+++ -title = "azure_subnet Resource" -platform = "azure" -draft = false -gh_repo = "inspec-azure" - -[menu.inspec] -title = "azure_subnet" -identifier = "inspec/resources/azure/azure_subnet Resource" -parent = "inspec/resources/azure" -+++ - -Use the `azure_subnet` InSpec audit resource to test properties related to a subnet for a given virtual network. - -## Azure REST API Version, Endpoint, and HTTP Client Parameters - -{{% inspec_azure_common_parameters %}} - -## Installation - -{{% inspec_azure_install %}} - -## Syntax - -`resource_group`, `vnet` and `name` or the `resource_id` must be given as a parameter. -```ruby -describe azure_subnet(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do - it { should exist } -end -``` ```ruby describe azure_subnet(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualNetworks/{vnName}/subnets/{subnetName}') do it { should exist } @@ -143,177 +39,81 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `vnet` -: Name of the Azure virtual network that the subnet is created in. `MyVNetName`. +: Name of the Azure virtual network where the subnet is created. `name` -: Name of the Azure subnet to test. `MySubnetName`. +: Name of the Azure subnet to test. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualNetworks/{vnName}/subnets/{subnetName}`. +: The unique resource ID. + +Provide one of the following parameter sets for a valid query: -Either one of the parameter sets can be provided for a valid query: - `resource_id` -- `resource_group`, `vnet` and `name` +- `resource_group`, `vnet`, and `name` -## Parameters +## Properties `address_prefix` -: The address prefix for the subnet. `its('address_prefix') { should eq "x.x.x.x/x" }`. + +: The address prefix for the subnet. `nsg` -: The network security group attached to the subnet. `its('nsg') { should eq 'MyNetworkSecurityGroupName' }`. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +: The network security group attached to the subnet. -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/subnets/get#subnet) for other properties available. +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/subnets/get#subnet) for other properties available. Any property in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Ensure that the Subnets Address Prefix is Configured As Expected.** +### Ensure that the subnets address prefix is configured as expected ```ruby -describe azure_subnet(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do +describe azure_subnet(resource_group: 'RESOURCE_GROUP', vnet: 'VNET_NAME', name: 'SUBNET_NAME') do its('address_prefix') { should eq '192.168.0.0/24' } end ``` -**Ensure that the Subnet is Attached to the Right Network Security Group.** + +### Ensure that the subnet is attached to the right network security group ```ruby -describe azure_subnet(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do +describe azure_subnet(resource_group: 'RESOURCE_GROUP', vnet: 'VNET_NAME', name: 'SUBNET_NAME') do its('nsg') { should eq 'NetworkSecurityGroupName'} end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# If a subnet is found it will exist - -describe azure_subnet(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do - it { should exist } -end - -# subnets that aren't found will not exist -describe azure_subnet(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'DoesNotExist') do - it { should_not exist } -end -``` +# If a subnet is found, it will exist. -## Azure Permissions - -Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be setup with a `contributor` role on the subscription you wish to test. - -+++ -title = "azure_subnet Resource" -platform = "azure" -draft = false -gh_repo = "inspec-azure" - -[menu.inspec] -title = "azure_subnet" -identifier = "inspec/resources/azure/azure_subnet Resource" -parent = "inspec/resources/azure" -+++ - -Use the `azure_subnet` InSpec audit resource to test properties related to a subnet for a given virtual network. - -## Azure REST API Version, Endpoint, and HTTP Client Parameters - -{{% inspec_azure_common_parameters %}} - -## Installation - -{{% inspec_azure_install %}} - -## Syntax - -`resource_group`, `vnet` and `name` or the `resource_id` must be given as a parameter. -```ruby -describe azure_subnet(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do - it { should exist } -end -``` -```ruby -describe azure_subnet(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualNetworks/{vnName}/subnets/{subnetName}') do +describe azure_subnet(resource_group: 'RESOURCE_GROUP', vnet: 'VNET_NAME', name: 'SUBNET_NAME') do it { should exist } end ``` -## Parameters - -`resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. - -`vnet` -: Name of the Azure virtual network that the subnet is created in. `MyVNetName`. - -`name` -: Name of the Azure subnet to test. `MySubnetName`. - -`resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualNetworks/{vnName}/subnets/{subnetName}`. - -Either one of the parameter sets can be provided for a valid query: -- `resource_id` -- `resource_group`, `vnet` and `name` - -## Parameters - -| Property | Description | -|----------|-------------| -| address_prefix | The address prefix for the subnet. `its('address_prefix') { should eq "x.x.x.x/x" }` | -| nsg | The network security group attached to the subnet. `its('nsg') { should eq 'MyNetworkSecurityGroupName' }` | - -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). - -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/subnets/get#subnet) for other properties available. -Any property in the response may be accessed with the key names separated by dots (`.`). - -## Examples - -**Ensure that the Subnets Address Prefix is Configured As Expected.** +### not_exists ```ruby -describe azure_subnet(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do - its('address_prefix') { should eq '192.168.0.0/24' } -end -``` -**Ensure that the Subnet is Attached to the Right Network Security Group.** - -```ruby -describe azure_subnet(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do - its('nsg') { should eq 'NetworkSecurityGroupName'} -end -``` - -## Matchers +# subnets that aren't found, will not exist. -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). - -### exists - -```ruby -# If a subnet is found it will exist - -describe azure_subnet(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do - it { should exist } -end - -# subnets that aren't found will not exist -describe azure_subnet(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'DoesNotExist') do +describe azure_subnet(resource_group: 'RESOURCE_GROUP', vnet: 'VNET_NAME', name: 'SUBNET_NAME') do it { should_not exist } end ``` ## Azure Permissions -Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be setup with a `contributor` role on the subscription you wish to test. - +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subnets.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subnets.md index bd2af152f8..467d24d2e0 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subnets.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subnets.md @@ -10,21 +10,22 @@ identifier = "inspec/resources/azure/azure_subnets Resource" parent = "inspec/resources/azure" +++ -Use the `azure_subnets` InSpec audit resource to test properties related to subnets of a virtual network. +Use the `azure_subnets` InSpec audit resource to test the properties related to subnets of a virtual network. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -The `resource_group` and `vnet` must be given as a parameter. +The `resource_group` and `vnet` are required parameters. + ```ruby -describe azure_subnets(resource_group: 'MyResourceGroup', vnet: 'MyVnetName') do +describe azure_subnets(resource_group: 'RESOURCE_GROUP', vnet: 'VNET_NAME') do #... end ``` @@ -32,15 +33,15 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `vnet` -: The virtual network that the subnet that you wish to test is a part of. +: The virtual network where the subnet you wish to test is a part of. ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -54,21 +55,26 @@ end : **Field**: `etag` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Exists if Any Subnets Exist for a Given Virtual Network in the Resource Group.** +### Exists if any subnets exist for a specified virtual network in the resource group ```ruby -describe azure_subnets(resource_group: 'MyResourceGroup', vnet: 'MyVnetName') do +describe azure_subnets(resource_group: 'RESOURCE_GROUP', vnet: 'VNET_NAME') do it { should exist } end ``` -**Filters the Results to Only Those that Match the Given Name.** + +### Filters the results to only those that match the specified name ```ruby -describe azure_subnets(resource_group: 'MyResourceGroup', vnet: 'MyVnetName') +describe azure_subnets(resource_group: 'RESOURCE_GROUP', vnet: 'VNET_NAME') .where(name: 'MySubnet') do it { should exist } end @@ -76,18 +82,20 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no subnets are in the virtual network +# Should not exist if no subnets are in the virtual network. -describe azure_subnets(resource_group: 'MyResourceGroup', vnet: 'MyVnetName') do +describe azure_subnets(resource_group: 'RESOURCE_GROUP', vnet: 'VNET_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subscription.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subscription.md index 36f6fcef73..42186d1cbc 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subscription.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subscription.md @@ -10,31 +10,36 @@ identifier = "inspec/resources/azure/azure_subscription Resource" parent = "inspec/resources/azure" +++ -Use the `azure_subscription` InSpec audit resource to test properties of the current subscription. +Use the `azure_subscription` InSpec audit resource to test the properties of the current subscription. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -This resource will retrieve the current subscription id that InSpec uses unless it is provided via `id` or `resource_id` parameters. +This resource will retrieve the current subscription ID that InSpec uses unless it is provided via `id` or `resource_id` parameters. + ```ruby describe azure_subscription do it { should exist } end ``` -or + +Or + ```ruby describe azure_subscription(id: '2e0b423p-aaaa-bbbb-1111-ee558463aabbd') do it { should exist } end ``` -or + +Or + ```ruby describe azure_subscription(resource_id: '/subscriptions/2e0b423p-aaaa-bbbb-1111-ee558463aabbd') do it { should exist } @@ -50,7 +55,7 @@ end : The fully qualified ID for the subscription. `/subscriptions/2e0b423p-aaaa-bbbb-1111-ee558463aabbd`. `locations_api_version` -: The endpoint api version for the `locations` property. Optional. The latest version will be used unless provided. +: The endpoint API version for the `locations` property. Optional. The latest version will be used unless provided. ## Properties @@ -67,10 +72,10 @@ end : The list of all available geo-location names. This includes physical and logical locations. `physical_locations*` -: The list of all available geo-location names that have the `metadata.regionType` is set to `Physical`. +: The list of all available geo-location names with the `metadata.regionType` is set to `Physical`. `logical_locations` -: The list of all available geo-location names that have the `metadata.regionType` is set to `Logical`. +: The list of all available geo-location names with the `metadata.regionType` is set to `Logical`. `locations_list` : The list of all available geo-location objects in [this](https://docs.microsoft.com/en-us/rest/api/resources/subscriptions/listlocations#location) format. @@ -79,73 +84,83 @@ end : An array containing the [tenants](https://docs.microsoft.com/en-us/rest/api/resources/subscriptions/get#managedbytenant) managing the subscription. `diagnostic_settings` -: The diagnostic settings set at a subcription level. +: The diagnostic settings set at a subscription level. `diagnostic_settings_enabled_logging` -: The enabled logging types from diagnostic settings set at a subcription level. +: The enabled logging types from diagnostic settings set at a subscription level. `diagnostic_settings_disabled_logging` -: The disabled logging types from diagnostic settings set at a subcription level. +: The disabled logging types from diagnostic settings set at a subscription level. -* `physical_locations` might be different than the `locations` property depending on the api version. -This is because of the change in the Azure API terminology. It is advised to see the [official documentation](https://docs.microsoft.com/en-us/rest/api/resources/subscriptions/listlocations) for more info. +* `physical_locations` might be different than the `locations` property depending on the API version. +This is because of the change in the Azure API terminology. It is advised to see the [official documentation](https://docs.microsoft.com/en-us/rest/api/resources/subscriptions/listlocations) for more information. -For properties applicable to all resources, such as `type`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type` and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/resources/subscriptions/get#subscription) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/resources/subscriptions/get#subscription) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test Your Subscription`s Display Name.** +### Test subscription`s display name ```ruby describe azure_subscription do its('name') { should cmp 'Demo Resources' } end ``` -**Test Your Subscription`s Authorization Source.** + +### Test subscription`s authorization source ```ruby describe azure_subscription do its('authorizationSource') { should cmp 'RoleBased' } end ``` -**Test Your Subscription`s Locations.** + +### Test subscription`s locations ```ruby describe azure_subscription do its('locations') { should include('eastus') } end -``` -**Test Your Subscription`s enabled logging types (via diagnostic settings).** +``` + +### Test subscription`s enabled logging types (via diagnostic settings) ```ruby describe azure_subscription do its('diagnostic_settings_enabled_logging_types') { should include('ResourceHealth') } end -``` -**Test Your Subscription`s disabled logging types (via diagnostic settings).** +``` + +### Test subscription`s disabled logging types (via diagnostic settings) ```ruby describe azure_subscription do its('diagnostic_settings_disabled_logging_types') { should include('Recommendation') } end -``` +``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# If we expect a resource to always exist +# If we expect a resource to always exist. describe azure_subscription do it { should exist } end -# If we expect a resource to never exist +``` + +### not_exists + +```ruby +# If we expect a resource to never exist. describe azure_subscription(id: 'fake_id') do it { should_not exist } @@ -154,4 +169,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subscriptions.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subscriptions.md index f5b9a5193e..adad56f72a 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subscriptions.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_subscriptions.md @@ -10,19 +10,20 @@ identifier = "inspec/resources/azure/azure_subscriptions Resource" parent = "inspec/resources/azure" +++ -Use the `azure_subscriptions` InSpec audit resource to test properties and configuration of all Azure subscriptions for a tenant. +Use the `azure_subscriptions` InSpec audit resource to test the properties and configuration of all Azure subscriptions for a tenant. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_subscriptions` resource block returns all subscription for a tenant. +An `azure_subscriptions` resource block returns all subscriptions for a tenant. + ```ruby describe azure_subscriptions do it { should exist } @@ -36,7 +37,7 @@ This resource does not require any parameters. ## Properties `ids` -: A list of the subscription ids. +: A list of the subscription IDs. : **Field**: `id` @@ -51,29 +52,36 @@ This resource does not require any parameters. : **Field**: `tags` `tenant_ids` -: A list of tenant ids of all the subscriptions. +: A list of tenant IDs of all the subscriptions. : **Field**: `tenant_id` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Check a Specific Subscription is Present.** +### Check a specific subscription is present ```ruby describe azure_subscriptions do its('names') { should include 'my-subscription' } end -``` +``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby describe azure_subscriptions do it { should exist } @@ -82,4 +90,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_notebook.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_notebook.md index 0e8a07cc5f..3a03676e74 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_notebook.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_notebook.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_synapse_notebook Resource" parent = "inspec/resources/azure" +++ -Use the `azure_synapse_notebook` InSpec audit resource to test properties related to a Azure Synapse notebook in a Synapse workspace. +Use the `azure_synapse_notebook` InSpec audit resource to test the properties related to an Azure Synapse notebook in a Synapse workspace. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -66,8 +66,7 @@ This resource requires the `endpoint` and `name` parameters for a valid query. `properties` : The properties of the notebook. - -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/synapse/data-plane/notebook/get-notebook) for other available properties. @@ -75,7 +74,7 @@ Access any property in the response by separating the key names with a period (` ## Examples -**Test that there are four cores for each executor.** +### Test that there are four cores for each executor ```ruby describe azure_synapse_notebook(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT', name: 'NOTEBOOK_NAME') do @@ -83,7 +82,7 @@ describe azure_synapse_notebook(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT', name end ``` -**Test that the notebook uses the Python kernel.** +### Test that the notebook uses the Python kernel ```ruby describe azure_synapse_notebook(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT', name: 'NOTEBOOK_NAME') do @@ -97,17 +96,19 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists -If a Synapse Notebook is found it will exist - ```ruby +# If a Synapse Notebook is found, it will exist. + describe azure_synapse_notebook(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT', name: 'NOTEBOOK_NAME') do it { should exist } end ``` -Synapse Notebooks that aren't found will not exist +### not_exists ```ruby +# Synapse Notebooks that aren't found, will not exist. + describe azure_synapse_notebook(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT', name: 'NOTEBOOK_NAME') do it { should_not exist } end @@ -115,4 +116,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_notebooks.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_notebooks.md index 03b7ffe9e4..a099a3b382 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_notebooks.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_notebooks.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_synapse_notebooks Resource" parent = "inspec/resources/azure" +++ -Use the `azure_synapse_notebooks` InSpec audit resource to test properties related to all Azure Synapse notebooks in a Synapse Analytics workspace. +Use the `azure_synapse_notebooks` InSpec audit resource to test the properties related to all Azure Synapse notebooks in a Synapse Analytics workspace. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -32,7 +32,7 @@ end ## Parameters -This resource requires the `endpoint` parameter for valid query. +This resource requires the `endpoint` parameter for a valid query. `endpoint` : The Azure Synapse workspace development endpoint. @@ -40,12 +40,12 @@ This resource requires the `endpoint` parameter for valid query. ## Properties `ids` -: A list of the unique Fully qualified resource IDs. +: A list of the unique fully qualified resource IDs. : **Field**: `id` `names` -: A list of name for all the Synapse notebooks. +: A list of names for all the Synapse notebooks. : **Field**: `name` @@ -55,7 +55,7 @@ This resource requires the `endpoint` parameter for valid query. : **Field**: `type` `properties` -: A list of Properties all the notebooks. +: A list of properties for all the notebooks. : **Field**: `properties` @@ -64,12 +64,15 @@ This resource requires the `endpoint` parameter for valid query. : **Field**: `tags` +{{< note >}} -{{% inspec_filter_table %}} +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through Synapse Notebooks by their names.** +### Loop through Synapse Notebooks by their names ```ruby azure_synapse_notebooks(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT').names.each do |name| @@ -79,7 +82,7 @@ azure_synapse_notebooks(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT').names.each d end ``` -**Test that there are Synapse Notebooks that include a certain string in their names (Client Side Filtering).** +### Test that there are Synapse Notebooks that include a certain string in their names (Client Side Filtering) ```ruby describe azure_synapse_notebooks(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT').where { name.include?('analytics-trends') } do @@ -89,21 +92,25 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} -### exists +This resource has the following special matchers. -Should not exist if there aren't any Synapse notebooks in the resource group. +### exists ```ruby +# Should not exist if there aren't any Synapse notebooks in the resource group. + describe azure_synapse_notebooks(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT') do it { should_not exist } end ``` -Should exist if the filter returns at least one Synapse notebook. +### not_exists ```ruby +# Should exist if the filter returns at least one Synapse notebook. + describe azure_synapse_notebooks(endpoint: 'WORKSPACE_DEVELOPMENT_ENDPOINT') do it { should exist } end @@ -111,4 +118,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_workspace.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_workspace.md new file mode 100644 index 0000000000..745dd78f93 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_workspace.md @@ -0,0 +1,109 @@ ++++ +title = "azure_synapse_workspace Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_synapse_workspace" +identifier = "inspec/resources/azure/azure_synapse_workspace Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_synapse_workspace` InSpec audit resource to test the properties related to an Azure Synapse workspace. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +```ruby +describe azure_synapse_workspace(resource_group: 'RESOURCE_GROUP', name: 'SYNAPSE_WORKSPACE_NAME') do + it { should exist } + its('type') { should eq 'Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups' } + its('location') { should eq 'eastus' } +end +``` + +```ruby +describe azure_synapse_workspace(resource_group: 'RESOURCE_GROUP', name: 'SYNAPSE_WORKSPACE_NAME') do + it { should exist } +end +``` + +## Parameters + +`name` _(required)_ +: Name of the Azure Synapse workspace to test. + +`resource_group` _(required)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`id` +: Resource ID. + +`name` +: Resource name. + +`type` +: Resource type. `Microsoft.Synapse/workspaces`. + +`location` +: The Geo-location where the resource lives. + +`properties` +: The properties of the Synapse workspaces. + +`properties.provisioningState` +: State of the resource. + +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). + +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/synapse/workspaces/get) for other properties available. + +## Examples + +### Test that the Synapse workspaces are provisioned successfully + +```ruby +describe azure_synapse_workspace(resource_group: 'RESOURCE_GROUP', name: 'SYNAPSE_WORKSPACE_NAME') do + its('properties.provisioningState') { should eq 'Succeeded' } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# If a Synapse workspace is found, it will exist. + +describe azure_synapse_workspace(resource_group: 'RESOURCE_GROUP', name: 'SYNAPSE_WORKSPACE_NAME') do + it { should exist } +end +``` + +### not_exists + +```ruby +# If Synapse workspaces are not found, it will not exist. + +describe azure_synapse_workspace(resource_group: 'RESOURCE_GROUP', name: 'SYNAPSE_WORKSPACE_NAME') do + it { should_not exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_workspaces.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_workspaces.md new file mode 100644 index 0000000000..7751d15440 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_synapse_workspaces.md @@ -0,0 +1,124 @@ ++++ +title = "azure_synapse_workspaces Resource" +platform = "azure" +draft = false +gh_repo = "inspec-azure" + +[menu.inspec] +title = "azure_synapse_workspaces" +identifier = "inspec/resources/azure/azure_synapse_workspaces Resource" +parent = "inspec/resources/azure" ++++ + +Use the `azure_synapse_workspaces` InSpec audit resource to test the properties related to all Azure Synapse workspaces. + +## Azure REST API Version, Endpoint, and HTTP Client Parameters + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} + +## Install + +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} + +## Syntax + +An `azure_synapse_workspaces` resource block returns all Azure Synapse workspaces. + +```ruby +describe azure_synapse_workspaces do + #... +end +``` + +## Parameters + +`resource_group` _(optional)_ +: Azure resource group where the targeted resource resides. + +## Properties + +`ids` +: A list of resource IDs. + +: **Field**: `id` + +`names` +: A list of resource names. + +: **Field**: `name` + +`types` +: A list of the resource types. + +: **Field**: `type` + +`properties` +: A list of properties for all the Synapse workspaces. + +: **Field**: `properties` + +`locations` +: A list of the Geo-locations. + +: **Field**: `location` + +`provisioningStates` +: A list of provisioning states of the Synapse workspaces. + +: **Field**: `provisioningState` + +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} + +## Examples + +### Loop through Synapse workspaces by their names + +```ruby +azure_synapse_workspaces.names.each do |name| + describe azure_synapse_workspace(resource_group: 'RESOURCE_GROUP', name: name) do + it { should exist } + end +end +``` + +### Test that there are Synapse workspaces that are successfully provisioned + +```ruby +describe azure_synapse_workspaces(resource_group: 'RESOURCE_GROUP').where(provisioningState: 'Succeeded') do + it { should exist } +end +``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### exists + +```ruby +# Should not exist if no Synapse workspaces are present. + +describe azure_synapse_workspaces(resource_group: 'RESOURCE_GROUP') do + it { should_not exist } +end +``` + +### not_exists + +```ruby +# Should exist if the filter returns at least one Synapse workspace. + +describe azure_synapse_workspaces(resource_group: 'RESOURCE_GROUP') do + it { should exist } +end +``` + +## Azure Permissions + +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machine.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machine.md index 2c5ba33bfe..c1f458e24b 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machine.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machine.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_virtual_machine Resource" parent = "inspec/resources/azure" +++ -Use the `azure_virtual_machine` InSpec audit resource to test properties related to a virtual machine. +Use the `azure_virtual_machine` InSpec audit resource to test the properties related to a virtual machine. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and virtual machine `name` or the `resource_id` must be given as a parameter. +`resource_group` and virtual machine `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_virtual_machine(resource_group: 'MyResourceGroup', name: 'MyVmName') do +describe azure_virtual_machine(resource_group: 'RESOURCE_GROUP', name: 'VM_NAME') do it { should exist } end ``` + ```ruby describe azure_virtual_machine(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}') do it { should exist } @@ -37,15 +39,16 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: Name of the Azure resource to test. `MyVM`. +: Name of the Azure resource to test. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` @@ -81,20 +84,20 @@ Either one of the parameter sets can be provided for a valid query: `data_disk_names` : The virtual machine's data disk names. `its('data_disk_names') { should include('DataDisk1') }`. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get#virtualmachine) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get#virtualmachine) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Ensure that the Virtual Machine has the Expected Data Disks.** +### Ensure that the virtual machine has the expected data Disks ```ruby describe azure_virtual_machine(resource_group: 'MyResourceGroup', name: 'MyVmName') do its('data_disk_names') { should include('DataDisk1') } end ``` + **Ensure that the Virtual Machine has the Expected Monitoring Agent Installed.** ```ruby @@ -110,46 +113,49 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a virtual machine is found it will exist +# If a virtual machine is found, it will exist. -describe azure_virtual_machine(resource_group: 'MyResourceGroup', name: 'MyVmName') do +describe azure_virtual_machine(resource_group: 'RESOURCE_GROUP', name: 'VM_NAME') do it { should exist } end -# virtual machines that aren't found will not exist -describe azure_virtual_machine(resource_group: 'MyResourceGroup', name: 'DoesNotExist') do +# virtual machines that are not found, will not exist. + +describe azure_virtual_machine(resource_group: 'RESOURCE_GROUP', name: 'VM_NAME') do it { should_not exist } end ``` + ### have_only_approved_extensions ```ruby -# Check if a virtual machine has only approved extensions. If an extension +# Check if a virtual machine has only approved extensions. The check will fail if an extension is used that's not on the list. -# is used that's not in the list then the check will fail. -describe azure_virtual_machine(resource_group: 'MyResourceGroup', name: 'MyVmName') do +describe azure_virtual_machine(resource_group: 'RESOURCE_GROUP', name: 'VM_NAME') do it { should have_only_approved_extensions(['ApprovedExtension', 'OtherApprovedExtensions']) } end ``` + ### have_monitoring_agent_installed ```ruby -# Will be true if the MicrosoftMonitoringAgent is installed (Windows only) +# Will be true if the MicrosoftMonitoringAgent is installed (Windows only). describe azure_virtual_machine(resource_group: 'MyResourceGroup', name: 'MyVmName') do it { should have_monitoring_agent_installed } end ``` + ### have_endpoint_protection_installed ```ruby # Will be true if any of the given extensions are installed. -describe azure_virtual_machine(resource_group: 'MyResourceGroup', name: 'MyVmName') do +describe azure_virtual_machine(resource_group: 'RESOURCE_GROUP', name: 'VM_NAME') do it { should have_endpoint_protection_installed(['Extension1', 'Extension2']) } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machine_disk.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machine_disk.md index 36b36aa721..b43bbee088 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machine_disk.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machine_disk.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_virtual_machine_disk Resource" parent = "inspec/resources/azure" +++ -Use the `azure_virtual_machine_disk` InSpec audit resource to test properties and configuration of an Azure disk. +Use the `azure_virtual_machine_disk` InSpec audit resource to test the properties and configuration of an Azure disk. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `name` or the `resource_id` must be given as a parameter. +`resource_group` and `name`, or the `resource_id` are required parameters. + ```ruby -describe azure_virtual_machine_disk(resource_group: 'inspec-resource-group-9', name: 'example_disk') do +describe azure_virtual_machine_disk(resource_group: 'RESOURCE_GROUP', name: 'EXAMPLE_DISK') do it { should exist } end ``` + ```ruby describe azure_virtual_machine_disk(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}') do it { should exist } @@ -37,12 +39,13 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: Name of the disk to test. `MyDisk`. +: Name of the disk to test. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` @@ -65,58 +68,65 @@ Either one of the parameter sets can be provided for a valid query: * The disk can still be encrypted at rest with a platform key, even though the `encryption_enabled` is `nil`. It is recommended to see [here](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disk-encryption) for more details on disk encryption. -For properties applicable to all resources, such as `type`, `name`, `location`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `location`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/compute/disks/get#disk) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/compute/disks/get#disk) for other properties available. +Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test If a Disk is Referenced with a Valid Name.** +### Test if a disk is referenced with a valid name ```ruby -describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'os_disk') do +describe azure_virtual_machine_disk(resource_group: 'RESOURCE_GROUP', name: 'OS_DISK') do it { should exist } end ``` -**Test If a Disk is Referenced with an Invalid Name.** + +### Test if a disk is referenced with an invalid name ```ruby -describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'i-dont-exist') do +describe azure_virtual_machine_disk(resource_group: 'RESOURCE_GROUP', name: 'i-dont-exist') do it { should_not exist } end -``` -**Test the VM that the Disk is Attached.** +``` + +### Test the VM that the disk is attached ```ruby -describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'os_disk') do +describe azure_virtual_machine_disk(resource_group: 'RESOURCE_GROUP', name: 'OS_DISK') do its('managedBy') { should cmp '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}' } end -``` -**Test the Type of Key Used to Encrypt the Data at Rest.** +``` + +### Test the key type used to encrypt the data at rest ```ruby -describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'os_disk') do +describe azure_virtual_machine_disk(resource_group: 'RESOURCE_GROUP', name: 'OS_DISK') do its('rest_encryption_type') { should cmp 'EncryptionAtRestWithPlatformKey' } end -``` -**Test a Disk's Size in Bytes.** +``` + +### Test a disk's size in bytes ```ruby -describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'os_disk') do +describe azure_virtual_machine_disk(resource_group: 'RESOURCE_GROUP', name: 'OS_DISK') do its('properties.diskSizeBytes') { should cmp 136367308800 } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### attached Test if a disk is attached to a virtual machine. + ```ruby -describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'os_disk') do +describe azure_virtual_machine_disk(resource_group: 'RESOURCE_GROUP', name: 'OS_DISK') do it { should be_attached } end ``` @@ -124,18 +134,23 @@ end ### exists ```ruby -# If we expect a resource to always exist +# If we expect a resource to always exist. -describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'os_disk') do +describe azure_virtual_machine_disk(resource_group: 'RESOURCE_GROUP', name: 'OS_DISK') do it { should exist } end -# If we expect a resource to never exist +``` + +### not_exists + +```ruby +# If we expect a resource to never exist. -describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'os_disk') do +describe azure_virtual_machine_disk(resource_group: 'RESOURCE_GROUP', name: 'OS_DISK') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machine_disks.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machine_disks.md index af1488b37f..50a2636c11 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machine_disks.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machine_disks.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_virtual_machine_disks Resource" parent = "inspec/resources/azure" +++ -Use the `azure_virtual_machine_disks` InSpec audit resource to test properties related to disks for a resource group or the entire subscription. +Use the `azure_virtual_machine_disks` InSpec audit resource to test the properties related to disks for a resource group or the entire subscription. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_virtual_machine_disks` resource block returns all disks, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_virtual_machine_disks` resource block returns all disks within a resource group (if provided) or an entire subscription. + ```ruby describe azure_virtual_machine_disks do it { should exist } end ``` -or + +Or + ```ruby -describe azure_virtual_machine_disks(resource_group: 'my-rg') do +describe azure_virtual_machine_disks(resource_group: 'RESOURCE_GROUP') do it { should exist } end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -59,7 +62,7 @@ end : **Field**: `resource_group` `names` -: A list of names all the disks. +: A list of names for all the disks. : **Field**: `name` @@ -78,35 +81,42 @@ end : **Field**: `tags` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Filter the Attached Disks.** +### Filter the attached disks ```ruby -describe azure_virtual_machine_disks(resource_group: 'MyResourceGroup').where(attached: true) do +describe azure_virtual_machine_disks(resource_group: 'RESOURCE_GROUP').where(attached: true) do it { should exist } its('count') { should eq 3} end -``` -**Loop through Disks by Their Ids .** +``` + +### Loop through disks by their IDs ```ruby azure_virtual_machine_disks.ids.each do |id| describe azure_virtual_machine_disk(resource_id: id) do it { should exist } end -end -``` -**Test that There are Disks that Include a Certain String in their Names (Client Side Filtering) .** +end +``` + +### Test that there are disks that include a certain string in their names (Client Side Filtering) ```ruby -describe azure_virtual_machine_disks(resource_group: 'MyResourceGroup').where { name.include?('Windows') } do +describe azure_virtual_machine_disks(resource_group: 'RESOURCE_GROUP').where { name.include?('Windows') } do it { should exist } end -``` -**Test that There are Disks that Include a Certain String in their Names (Server Side Filtering via Generic Resource - Recommended) .** +``` + +### Test that there are disks that include a certain string in their names (Server Side Filtering via Generic Resource - Recommended) ```ruby describe azure_generic_resources(resource_provider: 'Microsoft.Compute/disks', substring_of_name: 'Windows') do @@ -116,18 +126,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no disks are in the resource group +# Should not exist if no disks are in the resource group. -describe azure_virtual_machine_disks(resource_group: 'MyResourceGroup') do +describe azure_virtual_machine_disks(resource_group: 'RESOURCE_GROUP') do it { should_not exist } end +``` -# Should exist if the filter returns a single virtual machine +### not_exists + +```ruby +# Should exist if the filter returns a single virtual machine. describe azure_virtual_machine_disks.where(attached: true ) do it { should exist } @@ -136,4 +152,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machines.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machines.md index 40059e8f0e..7b88bac3a2 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machines.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_machines.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_virtual_machines Resource" parent = "inspec/resources/azure" +++ -Use the `azure_virtual_machines` InSpec audit resource to test properties related to virtual machines for a resource group or the entire subscription. +Use the `azure_virtual_machines` InSpec audit resource to test the properties related to virtual machines for a resource group or the entire subscription. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_virtual_machines` resource block returns all Azure virtual machines, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_virtual_machines` resource block returns all Azure virtual machines within a resource group (if provided) or an entire subscription. + ```ruby describe azure_virtual_machines do #... end ``` -or + +Or + ```ruby -describe azure_virtual_machines(resource_group: 'my-rg') do +describe azure_virtual_machines(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -73,75 +76,90 @@ end : **Field**: `tags` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test If Any Virtual Machines Exist in the Resource Group.** +### Test if any virtual machines exist in the resource group ```ruby -describe azure_virtual_machines(resource_group: 'MyResourceGroup') do +describe azure_virtual_machines(resource_group: 'RESOURCE_GROUP') do it { should exist } end ``` + **Filters Based on Platform.** ```ruby -describe azure_virtual_machines(resource_group: 'MyResourceGroup').where(platform: 'windows') do +describe azure_virtual_machines(resource_group: 'RESOURCE_GROUP').where(platform: 'windows') do it { should exist } end -``` -**Loop through Virtual Machines by Their Ids .** +``` + +### Loop through virtual machines by their IDs ```ruby azure_virtual_machines.ids.each do |id| describe azure_virtual_machine(resource_id: id) do it { should exist } end -end -``` -**Test If There are Windows Virtual Machines .** +end +``` + +### Test if there are Windows virtual machines ```ruby -describe azure_virtual_machines(resource_group: 'MyResourceGroup').where(platform: 'windows') do +describe azure_virtual_machines(resource_group: 'RESOURCE_GROUP').where(platform: 'windows') do it { should exist } end -``` -**Test that There are Virtual Machines that Includes a Certain String in their Names (Client Side Filtering) .** +``` + +### Test that there are virtual machines that includes a certain string in their names (Client Side Filtering) ```ruby describe azure_virtual_machines(resource_group: 'MyResourceGroup').where { name.include?('WindowsVm') } do it { should exist } end -``` -**Test that There are Virtual Machine that Includes a Certain String in their Names (Server Side Filtering via Generic Resource - Recommended) .** +``` + +### Test that there are virtual machine that includes a certain string in their names (Server Side Filtering via Generic Resource - Recommended) ```ruby -describe azure_generic_resources(resource_group: 'MyResourceGroup', resource_provider: 'Microsoft.Compute/virtualMachine', substring_of_name: 'WindowsVm') do +describe azure_generic_resources(resource_group: 'RESOURCE_GROUP', resource_provider: 'Microsoft.Compute/virtualMachine', substring_of_name: 'WindowsVm') do it { should exist } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no virtual machines are in the resource group +# Should not exist if no virtual machines are in the resource group. -describe azure_virtual_machines(resource_group: 'MyResourceGroup') do +describe azure_virtual_machines(resource_group: 'RESOURCE_GROUP') do it { should_not exist } end +``` -# Should exist if the filter returns a single virtual machine +### not_exists + +```ruby +# Should exist if the filter returns a single virtual machine. -describe azure_virtual_machines(resource_group: 'MyResourceGroup').where(platform: 'windows') do +describe azure_virtual_machines(resource_group: 'RESOURCE_GROUP').where(platform: 'windows') do it { should exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network.md index 634400d1cc..1e75514869 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_virtual_network Resource" parent = "inspec/resources/azure" +++ -Use the `azure_virtual_network` InSpec audit resource to test properties related to a virtual network. +Use the `azure_virtual_network` InSpec audit resource to test the properties related to a virtual network. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and virtual network `name` or the `resource_id` must be given as a parameter. +`resource_group` and virtual network `name` or the `resource_id` are required parameters. + ```ruby -describe azure_virtual_network(resource_group: 'MyResourceGroup', name: 'MyVnetName') do +describe azure_virtual_network(resource_group: 'RESOURCE_GROUP', name: 'VNET_NAME') do it { should exist } end ``` + ```ruby describe azure_virtual_network(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualNetworks/{vnName}') do it { should exist } @@ -37,15 +39,16 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: Name of the virtual network to test. `MyVNetwork`. +: Name of the virtual network to test. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualNetworks/{vnName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` @@ -69,55 +72,63 @@ Either one of the parameter sets can be provided for a valid query: `enable_vm_protection` : Boolean value showing if the virtual network has VM protection enabled. `its('enable_vm_protection') { should eq false }`. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/virtualnetworks/get#virtualnetwork) for other properties available. -Any property in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/virtualnetworks/get#virtualnetwork) for other properties available. Any property in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Ensure that the Virtual Network Exists in the East US Region.** +### Ensure that the Virtual Network exists in the east US region ```ruby -describe azure_virtual_network(resource_group: 'resource_group', name: 'MyVnetName') do +describe azure_virtual_network(resource_group: 'RESOURCE_GROUP', name: 'VNET_NAME') do it { should exist } its('location') { should eq 'eastus' } end ``` -**Ensure that the Virtual Network's DNS Servers are Configured as Expected.** + +### Ensure that the Virtual Network's DNS servers are configured as expected ```ruby -describe azure_virtual_network(resource_group: 'resource_group', name: 'MyVnetName') do +describe azure_virtual_network(resource_group: 'RESOURCE_GROUP', name: 'VNET_NAME') do its('dns_servers') { should eq ["192.168.0.6"] } end ``` -**Ensure that the Virtual Network's Address Space is Configured as Expected.** + +### Ensure that the Virtual Network's address space is configured as expected ```ruby -describe azure_virtual_network(resource_group: 'resource_group', name: 'MyVnetName') do +describe azure_virtual_network(resource_group: 'RESOURCE_GROUP', name: 'VNET_NAME') do its('address_space') { should eq ["192.168.0.0/24"] } end -``` +``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# If a virtual network is found it will exist +# If a virtual network is found, it will exist. -describe azure_virtual_network(resource_group: 'MyResourceGroup', name: 'MyVnetName') do +describe azure_virtual_network(resource_group: 'RESOURCE_GROUP', name: 'VNET_NAME') do it { should exist } end +``` + +### not_exists + +```ruby +# Virtual networks that are not found, will not exist. -# virtual networks that aren't found will not exist -describe azure_virtual_network(resource_group: 'MyResourceGroup', name: 'DoesNotExist') do +describe azure_virtual_network(resource_group: 'RESOURCE_GROUP', name: 'DOESNOTEXIST') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateway.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateway.md index 58cdac860b..1d33867160 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateway.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateway.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_virtual_network_gateway Resource" parent = "inspec/resources/azure" +++ -Use the `azure_virtual_network_gateway` InSpec audit resource to test the properties and configuration of an Azure virtual network gateway. +Use the `azure_virtual_network_gateway` InSpec audit resource to test the properties and configuration of an Azure Virtual Network Gateway. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -34,7 +34,7 @@ end `resource_group` _(REQUIRED)_ -: The Azure resource group that the targeted resource resides in. +: The Azure resource group where the targeted resource resides. `name` _(REQUIRED)_ @@ -67,15 +67,15 @@ end : The provisioning state of the virtual network gateway resource. `properties.vpnClientConfiguration` -: The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations. +: The reference to the VpnClientConfiguration resource, which represents the P2S VpnClient configurations. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/network-gateway/virtual-network-gateways/get) for other available properties. Any attribute in the response is accessed with the key names separated by dots (`.`). ## Examples -**Test the VPN client protocol of a virtual network gateway.** +### Test the VPN client protocol of a virtual network gateway ```ruby describe azure_virtual_network_gateway(resource_group: 'RESOURCE_GROUP', name: 'VIRTUAL_NETWORK_NAME') do @@ -90,13 +90,17 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If we expect a virtual network gateway to always exist +# If we expect a virtual network gateway to always exist. describe azure_virtual_network_gateway(resource_group: 'RESOURCE_GROUP', name: 'VIRTUAL_NETWORK_NAME') do it { should exist } end +``` + +### not_exists -# If we expect virtual network gateway to never exist +```ruby +# If we expect a virtual network gateway to never exist. describe azure_virtual_network_gateway(resource_group: 'RESOURCE_GROUP', name: 'VIRTUAL_NETWORK_NAME') do it { should_not exist } @@ -105,4 +109,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="reader" %}} +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateway_connection.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateway_connection.md index 82f71d7126..5d0ce35a80 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateway_connection.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateway_connection.md @@ -14,11 +14,11 @@ Use the `azure_virtual_network_gateway_connection` InSpec audit resource to test ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -33,13 +33,12 @@ end ## Parameters `name` -: Name of the Azure Virtual Network Gateway Connection to test. +: Name of the Azure Virtual Network Gateway connection to test. `resource_group` : Azure resource group name where the targeted resource resides. -The parameter set should be provided for a valid query: -- `resource_group` and `name` +The parameter set should be provided for a valid query is `resource_group` and `name`. ## Properties @@ -70,13 +69,13 @@ The parameter set should be provided for a valid query: `properties.ipsecPolicies` : The IPSec Policies to be considered by this connection. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/network-gateway/virtual-network-gateway-connections/get) for other properties available. Any attribute in the response is accessed with the key names separated by dots (`.`). ## Examples -**Test that the Virtual Network Gateway connection protocol is IKEv1.** +### Test that the Virtual Network Gateway connection protocol is IKEv1 ```ruby describe azure_virtual_network_gateway_connection(resource_group: 'RESOURCE_GROUP', name: 'VIRTUAL_NETWORK_NAME') do @@ -91,13 +90,17 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a Virtual Network Gateway Connection is found it will exist +# If a Virtual Network Gateway connection is found, it will exist. describe azure_virtual_network_gateway_connection(resource_group: 'RESOURCE_GROUP', name: 'VIRTUAL_NETWORK_NAME') do it { should exist } end +``` + +### not_exists -# if Virtual Network Gateway Connection is not found it will not exist +```ruby +# If Virtual Network Gateway connection is not found, it will not exist. describe azure_virtual_network_gateway_connection(resource_group: 'RESOURCE_GROUP', name: 'VIRTUAL_NETWORK_NAME') do it { should_not exist } @@ -106,4 +109,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="reader" %}} +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateway_connections.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateway_connections.md index 4beb8af901..4f1e7bfe0e 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateway_connections.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateway_connections.md @@ -14,11 +14,11 @@ Use the `azure_virtual_network_gateway_connections` InSpec audit resource to tes ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -92,15 +92,19 @@ The parameter set should be provided for a valid query: : **Field**: `datacenterManagementServerName` `ipsecPolicies` -: A list of all The IPSec Policies to be considered by this connection. +: A list of all the IPSec policies to be considered by this connection. : **Field**: `ipsecPolicies` -* For information on how to use filter criteria on plural resources refer to [FilterTable usage](https://github.com/inspec/inspec/blob/master/dev-docs/filtertable-usage.md). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/network-gateway/virtual-network-gateway-connections/list) for other properties available. +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through Virtual Network Gateway connection by their names.** +### Loop through Virtual Network Gateway connection by their names ```ruby azure_virtual_network_gateway_connections(resource_group: 'RESOURCE_GROUP').names.each do |name| @@ -110,7 +114,7 @@ azure_virtual_network_gateway_connections(resource_group: 'RESOURCE_GROUP').name end ``` -**Test that there are Virtual Network Gateway connection with IPsec type .** +### Test that there are Virtual Network Gateway connections with IPsec type ```ruby describe azure_virtual_network_gateway_connections(resource_group: 'RESOURCE_GROUP').where(connectionType: 'VPN_CONNECTION_TYPE') do @@ -120,18 +124,24 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no Virtual Network Gateway Connection are present in the project and in the resource group +# Should not exist if no Virtual Network Gateway connection is present in the project and the resource group. describe azure_virtual_network_gateway_connections(resource_group: 'RESOURCE_GROUP') do it { should_not exist } end +``` + +### not_exists -# Should exist if the filter returns at least one Virtual Network Gateway Connection in the project and in the resource group +```ruby +# Should exist if the filter returns at least one Virtual Network Gateway connection in the project and the resource group. describe azure_virtual_network_gateway_connections(resource_group: 'RESOURCE_GROUP') do it { should exist } @@ -140,4 +150,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="reader" %}} +{{% inspec-azure/azure_permissions_service_principal role="reader" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateways.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateways.md index 353526dcd9..bbef6e3337 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateways.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_gateways.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_virtual_network_gateways Resource" parent = "inspec/resources/azure" +++ -Use the `azure_virtual_network_gateways` InSpec audit resource to test properties and configuration of multiple Azure Virtual Network Gateways. +Use the `azure_virtual_network_gateways` InSpec audit resource to test the properties and configuration of multiple Azure Virtual Network Gateways. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_virtual_network_gateways` resource block returns all VPN gateways, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_virtual_network_gateways` resource block returns all VPN gateways within a resource group (if provided) or an entire subscription. + ```ruby describe azure_virtual_network_gateways do #... end ``` -or + +Or + ```ruby -describe azure_virtual_network_gateways(resource_group: 'my-rg') do +describe azure_virtual_network_gateways(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -68,37 +71,50 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test that an Example Resource Group has the Named VPN gateway.** +### Test that an example resource group has the named VPN gateway ```ruby -describe azure_virtual_network_gateways(resource_group: 'ExampleGroup') do +describe azure_virtual_network_gateways(resource_group: 'EXAMPLEGROUP') do its('names') { should include('ExampleName') } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby -# If we expect 'ExampleGroup' Resource Group to have VPN Gateways -describe azure_virtual_network_gateways(resource_group: 'ExampleGroup') do +# If we expect 'EXAMPLEGROUP' resource group to have VPN Gateways. + +describe azure_virtual_network_gateways(resource_group: 'EXAMPLEGROUP') do it { should exist } end +``` + +### not_exists + +```ruby +# If we expect 'EMPTYEXAMPLEGROUP' resource group to not have VPN Gateways. -# If we expect 'EmptyExampleGroup' Resource Group to not have VPN Gateways -describe azure_virtual_network_gateways(resource_group: 'EmptyExampleGroup') do +describe azure_virtual_network_gateways(resource_group: 'EMPTYEXAMPLEGROUP') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_peering.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_peering.md index ca6154e4a3..07ef9aac46 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_peering.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_peering.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_virtual_network_peering Resource" parent = "inspec/resources/azure" +++ -Use the `azure_virtual_network_peering` InSpec audit resource to test properties related to a peering for a virtual network. +Use the `azure_virtual_network_peering` InSpec audit resource to test the properties related to peering for a virtual network. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -This resource requires either the `resource_id` parameter or the `resource_group`, `vnet` and `name` parameters. +This resource requires either the `resource_id` parameter or the `resource_group`, `vnet,` and `name` parameters. + ```ruby -describe azure_virtual_network_peering(resource_group: 'MyResourceGroup',vnet: 'virtual-network-name' name: 'virtual-network-peering-name') do +describe azure_virtual_network_peering(resource_group: 'RESOURCE_GROUP',vnet: 'VIRTUAL-NETWORK-NAME' name: 'VIRTUAL-NETWORK-PEERING-NAME') do it { should exist } end ``` + ```ruby describe azure_virtual_network_peering(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualNetworks/{vnName}/virtualNetworkPeerings/{virtualNetworkPeeringName}') do it { should exist } @@ -37,18 +39,19 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `vnet` -: Name of the Azure virtual network that the virtual network peering is created in. `MyVNetName`. +: Name of the Azure virtual network where the virtual network peering is created. `name` -: Name of the Azure virtual network peering to test. `MyVirtualNetworkPeeringName`. +: Name of the Azure virtual network peering to test. `resource_id` -: The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualNetworks/{vnName}/virtualNetworkPeerings/{virtualNetworkPeeringName}`. +: The unique resource ID. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group`, `vnet` and `name` @@ -57,41 +60,46 @@ Either one of the parameter sets can be provided for a valid query: `peering_state` : The peering state for the virtual network peering. `its('peering_state') { should eq "Connected" }`. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/virtual-network-peerings/get#virtualnetworkpeering) for other properties available. -Any property in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/virtual-network-peerings/get#virtualnetworkpeering) for other properties available. Any property in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Ensure that the Virtual Network Peering State is Connected .** +### Ensure that the Virtual Network Peering state is connected ```ruby -describe azure_virtual_network_peering(resource_group: 'MyResourceGroup',vnet: 'virtual-network-name' name: 'virtual-network-peering-name') do +describe azure_virtual_network_peering(resource_group: 'RESOURCE_GROUP',vnet: 'VIRTUAL-NETWORK-NAME' name: 'VIRTUAL-NETWORK-PEERING-NAME') do its('peering_state') { should eq 'Connected' } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# If a Virtual Network Peering is found it will exist +# If a Virtual Network Peering is found, it will exist. -describe azure_virtual_network_peering(resource_group: 'MyResourceGroup',vnet: 'virtual-network-name' name: 'virtual-network-peering-name') do do +describe azure_virtual_network_peering(resource_group: 'RESOURCE_GROUP',vnet: 'VIRTUAL-NETWORK-NAME' name: 'VIRTUAL-NETWORK-PEERING-NAME') do it { should exist } end +``` -# Virtual Network Peerings that aren't found will not exist -describe azure_virtual_network_peering(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'DoesNotExist') do +### not_exists + +```ruby +# Virtual Network Peerings that are not found, will not exist. + +describe azure_virtual_network_peering(resource_group: 'RESOURCE_GROUP',vnet: 'VIRTUAL-NETWORK-NAME' name: 'VIRTUAL-NETWORK-PEERING-NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} - +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_peerings.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_peerings.md index 8b76203cf9..8422fa3728 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_peerings.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_network_peerings.md @@ -10,21 +10,22 @@ identifier = "inspec/resources/azure/azure_virtual_network_peerings Resource" parent = "inspec/resources/azure" +++ -Use the `azure_virtual_network_peerings` InSpec audit resource to test properties related to virtual network peerings of a virtual network. +Use the `azure_virtual_network_peerings` InSpec audit resource to test the properties related to virtual network peerings of a virtual network. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax `resource_group` and `vnet` are required parameters. + ```ruby -describe azure_virtual_network_peerings(resource_group: 'MyResourceGroup', vnet: 'virtual-network-name') do +describe azure_virtual_network_peerings(resource_group: 'RESOURCE_GROUP', vnet: 'VIRTUAL-NETWORK-NAME') do #... end ``` @@ -32,15 +33,15 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `vnet` -: The virtual network that the network peering that you wish to test is a part of. +: The virtual network where the network PEERING you wish to test is part. ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -54,21 +55,26 @@ end : **Field**: `etag` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Exists if Any Virtual Network Peerings Exist for a Given Virtual Network in the Resource Group.** +### Exists if any Virtual Network Peerings exist for a given Virtual Network in the resource group ```ruby describe azure_virtual_network_peerings(resource_group: 'MyResourceGroup', vnet: 'virtual-network-name') do it { should exist } end ``` + **Filters the Results to Only Those that Match the Given Name.** ```ruby -describe azure_virtual_network_peerings(resource_group: 'MyResourceGroup', vnet: 'virtual-network-name') do +describe azure_virtual_network_peerings(resource_group: 'RESOURCE_GROUP', vnet: 'VIRTUAL-NETWORK-NAME') do .where(name: 'MyVirtualNetworkPeering') do it { should exist } end @@ -76,18 +82,20 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no virtual network peerings are in the virtual network +# Should not exist if no virtual network peerings are in the virtual network. -describe azure_virtual_network_peerings(resource_group: 'MyResourceGroup', vnet: 'virtual-network-name') do +describe azure_virtual_network_peerings(resource_group: 'RESOURCE_GROUP', vnet: 'VIRTUAL-NETWORK-NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_networks.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_networks.md index 72dc36cb73..e562de805c 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_networks.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_networks.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_virtual_networks Resource" parent = "inspec/resources/azure" +++ -Use the `azure_virtual_networks` InSpec audit resource to test properties related to virtual networks within your subscription. +Use the `azure_virtual_networks` InSpec audit resource to test the properties related to virtual networks within your subscription. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_virtual_networks` resource block returns all Azure virtual networks, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_virtual_networks` resource block returns all Azure virtual networks within a resource group (if provided) or an entire subscription. + ```ruby describe azure_virtual_networks do #... end ``` -or + +Or + ```ruby -describe azure_virtual_networks(resource_group: 'my-rg') do +describe azure_virtual_networks(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -68,64 +71,75 @@ end : **Field**: `etag` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Exists If Any Virtual Networks Exist in the Resource Group.** +### Exists if any virtual networks exist in the resource group ```ruby -describe azure_virtual_networks(resource_group: 'MyResourceGroup') do +describe azure_virtual_networks(resource_group: 'RESOURCE_GROUP') do it { should exist } end ``` -**Filters the Results to Only Those that Match the Given Name (Client Side).** + +### Filters the results to only those that match the given name (Client Side) ```ruby **Insist that MyVnetName exists.** -describe azure_virtual_networks(resource_group: 'MyResourceGroup').where(name: 'MyVnetName') do +describe azure_virtual_networks(resource_group: 'RESOURCE_GROUP').where(name: 'VNET_NAME') do it { should exist } end ``` + ```ruby **Insist that you have at least one virtual network that starts with 'prefix'.** -describe azure_virtual_networks(resource_group: 'MyResourceGroup').where { name.include?('project_A') } do +describe azure_virtual_networks(resource_group: 'RESOURCE_GROUP').where { name.include?('project_A') } do it { should exist } end ``` -**Filters the Networks at Azure API to Only Those that Match the Given Name via Generic Resource (Recommended).** + +### Filters the networks at Azure API to only those that match the given name via a generic resource (Recommended) ```ruby **Fuzzy string matching.** -describe azure_generic_resources(resource_group: 'MyResourceGroup', resource_provider: 'Microsoft.Network/virtualNetworks', substring_of_name: 'project_A') do +describe azure_generic_resources(resource_group: 'RESOURCE_GROUP', resource_provider: 'Microsoft.Network/virtualNetworks', substring_of_name: 'project_A') do it { should exist } end ``` + ```ruby + **Exact name matching.** -describe azure_generic_resources(resource_group: 'MyResourceGroup', resource_provider: 'Microsoft.Network/virtualNetworks', name: 'MyVnetName') do +describe azure_generic_resources(resource_group: 'RESOURCE_GROUP', resource_provider: 'Microsoft.Network/virtualNetworks', name: 'MyVnetName') do it { should exist } end -``` +``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no virtual networks are in the resource group +# Should not exist if no virtual networks are in the resource group. -describe azure_virtual_networks(resource_group: 'MyResourceGroup') do +describe azure_virtual_networks(resource_group: 'RESOURCE_GROUP') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_wan.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_wan.md index 779a0505c8..1d1d3b6daf 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_wan.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_wan.md @@ -10,15 +10,15 @@ identifier = "inspec/resources/azure/azure_virtual_wan Resource" parent = "inspec/resources/azure" +++ -Use the `azure_virtual_wan` InSpec audit resource to test the properties related to a Azure Virtual WAN in a given resource group. +Use the `azure_virtual_wan` InSpec audit resource to test the properties related to an Azure Virtual WAN in a given resource group. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -69,7 +69,7 @@ end : VPN encryption to be disabled or not. `properties.allowBranchToBranchTraffic` -: True if branch to branch traffic is allowed. +: True if branch-to-branch traffic is allowed. `properties.office365LocalBreakoutCategory` : The office local breakout category. @@ -77,13 +77,13 @@ end `properties.type` : The type of the Virtual WAN. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/virtualwan/virtual-wans/get) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples -**Test that a Virtual WAN's Encryption is not disabled.** +### Test that a Virtual WAN's encryption is not disabled ```ruby describe azure_virtual_wan(resource_group: 'RESOURCE_GROUP', name: 'DEFAULT_WAN') do @@ -98,12 +98,18 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a Virtual WAN is found, it will exist +# If a Virtual WAN is found, it will exist. + describe azure_virtual_wan(resource_group: 'RESOURCE_GROUP', name: 'DEFAULT_WAN') do it { should exist } end +``` + +### not_exists + +```ruby +# If no Virtual WAN's are found, it will not exist. -# If no Virtual WAN's are found, it will not exist describe azure_virtual_wan(resource_group: 'RESOURCE_GROUP', name: 'DEFAULT_WAN') do it { should_not exist } end @@ -111,4 +117,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_wans.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_wans.md index 0354fa366b..9cf31d5d78 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_wans.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_virtual_wans.md @@ -14,11 +14,11 @@ Use the `azure_virtual_wans` InSpec audit resource to test the properties relate ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax @@ -37,17 +37,17 @@ This resource does not require any parameters. ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` `names` -: A list of names for all the Resources. +: A list of names for all the resources. : **Field**: `name` `etags` -: A list of etag for all the Resources. +: A list of etag for all the resources. : **Field**: `etag` @@ -62,15 +62,19 @@ This resource does not require any parameters. : **Field**: `location` `properties` -: A list of Properties all the resources. +: A list of properties for all the resources. : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test that the Virtual WAN type is Standard.** +### Test that the Virtual WAN type is standard ```ruby describe azure_virtual_wans.where{ properties.select{|prop| prop.type == 'Standard' } } do @@ -80,18 +84,20 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no virtual WANs are present +# Should not exist if no virtual WANs are present. describe azure_virtual_wans do it { should_not exist } end -# Should exist if the filter returns at least one virtual WAN +# Should exist if the filter returns at least one virtual WAN. describe azure_virtual_wans do it { should exist } @@ -100,4 +106,4 @@ end ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_web_app_function.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_web_app_function.md index 13e8b2925b..05371ffd9c 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_web_app_function.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_web_app_function.md @@ -10,19 +10,20 @@ identifier = "inspec/resources/azure/azure_web_app_function Resource" parent = "inspec/resources/azure" +++ -Use the `azure_web_app_function` InSpec audit resource to test properties related to a Azure function . +Use the `azure_web_app_function` InSpec audit resource to test the properties related to an Azure function. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `site_name` and `function_name` or the `resource_id` must be given as a parameter. +`resource_group` and `site_name` and `function_name` or the `resource_id` are required parameters. + ```ruby describe azure_web_app_function(resource_group: resource_group, site_name: site_name, function_name: function_name) do it { should exist } @@ -32,6 +33,7 @@ describe azure_web_app_function(resource_group: resource_group, site_name: site_ its('properties.language') { should cmp 'Javascript' } end ``` + ```ruby describe azure_web_app_function(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Web/sites/{siteName}/functions/{functionName}') do it { should exist } @@ -41,21 +43,22 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` -: Name of the Azure Function App to test. `FunctionApp`. +: Name of the Azure function app to test. `FunctionApp`. `site_name` -: Name of the Azure Function App to test (for backward compatibility). `FunctionApp`. +: Name of the Azure function app to test (for backward compatibility). `FunctionApp`. `function_name` -: Name of the Azure Function to test `Function`. +: Name of the Azure function to test `Function`. `resource_id` : The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Web/sites/{siteName}/functions/{functionName}`. Either one of the parameter sets can be provided for a valid query: + - `resource_id` - `resource_group` and `name` and `function_name` - `resource_group` and `site_name` and `function_name` @@ -66,7 +69,7 @@ Either one of the parameter sets can be provided for a valid query: : Config URI. `function_app_id` -: Function App ID. +: Function app ID. `language` : The function language. @@ -74,24 +77,24 @@ Either one of the parameter sets can be provided for a valid query: `isDisabled` : Gets or sets a value indicating whether the function is disabled. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/appservice/webapps/getfunction#functionenvelope) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`). +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/appservice/webapps/getfunction#functionenvelope) for other properties available. Any attribute in the response may be accessed with the key names separated by dots (`.`). ## Examples **Test <>.** ```ruby -describe azure_web_app_function(resource_group: 'MyResourceGroup', site_name: 'functions-http', function_name: 'HttpTrigger1') do +describe azure_web_app_function(resource_group: 'RESOURCE_GROUP', site_name: 'functions-http', function_name: 'HttpTrigger1') do its('properties.language') { should eq 'Javascript' } end ``` + **Test <>.** ```ruby -describe azure_web_app_function(resource_group: 'MyResourceGroup', site_name: 'functions-http', function_name: 'HttpTrigger1') do +describe azure_web_app_function(resource_group: 'RESOURCE_GROUP', site_name: 'functions-http', function_name: 'HttpTrigger1') do its('properties.isDisabled') { should be_false } end ``` @@ -103,18 +106,23 @@ This InSpec audit resource has the following special matchers. For a full list o ### exists ```ruby -# If a key vault is found it will exist +# If a key vault is found, it will exist. -describe azure_web_app_function(resource_group: 'MyResourceGroup', site_name: 'functions-http', function_name: 'HttpTrigger1') do +describe azure_web_app_function(resource_group: 'RESOURCE_GROUP', site_name: 'functions-http', function_name: 'HttpTrigger1') do it { should exist } end +``` + +### not_exists + +```ruby +# Key vaults that are not found, will not exist. -# Key vaults that aren't found will not exist -describe azure_web_app_function(resource_group: 'MyResourceGroup', site_name: 'functions-http', function_name: 'HttpTrigger1') do +describe azure_web_app_function(resource_group: 'RESOURCE_GROUP', site_name: 'functions-http', function_name: 'HttpTrigger1') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_web_app_functions.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_web_app_functions.md index aa4c46c78b..7cfd28c8a2 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_web_app_functions.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_web_app_functions.md @@ -10,22 +10,22 @@ identifier = "inspec/resources/azure/azure_web_app_functions Resource" parent = "inspec/resources/azure" +++ -Use the `azure_web_app_functions` InSpec audit resource to test properties related to azure functions for a resource group or the entire subscription. +Use the `azure_web_app_functions` InSpec audit resource to test the properties related to azure functions for a resource group or the entire subscription. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_web_app_functions` resource block returns all Azure functions, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_web_app_functions` resource block returns all Azure functions within a resource group (if provided) or an entire subscription. ```ruby -describe azure_web_app_functions(resource_group: 'my-rg', site_name: 'function-app-http') do +describe azure_web_app_functions(resource_group: 'RESOURCE_GROUP', site_name: 'function-app-http') do #... end ``` @@ -33,7 +33,7 @@ end or ```ruby -describe azure_web_app_functions(resource_group: 'my-rg', site_name: 'function-app-http') do +describe azure_web_app_functions(resource_group: 'RESOURCE_GROUP', site_name: 'function-app-http') do #... end ``` @@ -51,7 +51,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -75,48 +75,58 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Loop through functions by their IDs.** +### Loop through functions by their IDs ```ruby -azure_web_app_functions(resource_group: 'my-rg', site_name: 'function-app-http').ids.each do |id| +azure_web_app_functions(resource_group: 'RESOURCE_GROUP', site_name: 'function-app-http').ids.each do |id| describe azure_web_app_function(resource_id: id) do it { should exist } end end ``` -**Test that there are functions that includes a certain string in their names (Client Side Filtering).** +### Test that there are functions that include a certain string in their names (Client Side Filtering) ```ruby -describe azure_web_app_functions(resource_group: 'my-rg', site_name: 'function-app-http').where { name.include?('queue') } do +describe azure_web_app_functions(resource_group: 'RESOURCE_GROUP', site_name: 'function-app-http').where { name.include?('queue') } do it { should exist } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists ```ruby -# Should not exist if no functions are in the resource group +# Should not exist if no functions are in the resource group. -describe azure_web_app_functions(resource_group: 'MyResourceGroup', site_name: 'function-app-http') do +describe azure_web_app_functions(resource_group: 'RESOURCE_GROUP', site_name: 'function-app-http') do it { should_not exist } end +``` + +### not_exists -# Should exist if the filter returns at least one key vault +```ruby +# Should exist if the filter returns at least one key vault. -describe azure_web_app_functions(resource_group: 'MyResourceGroup', site_name: 'function-app-http') do +describe azure_web_app_functions(resource_group: 'RESOURCE_GROUP', site_name: 'function-app-http') do it { should exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_webapp.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_webapp.md index cadef6ebcc..4032481714 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_webapp.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_webapp.md @@ -10,24 +10,26 @@ identifier = "inspec/resources/azure/azure_webapp Resource" parent = "inspec/resources/azure" +++ -Use the `azure_webapp` InSpec audit resource to test properties and configuration of an Azure webapp. +Use the `azure_webapp` InSpec audit resource to test the properties and configuration of an Azure webapp. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -`resource_group` and `name` or the `resource_id` must be given as a parameter. +`resource_group` and `name` or the `resource_id` are required parameters. + ```ruby -describe azure_webapp(resource_group: 'inspec-rg', name: 'my_app') do +describe azure_webapp(resource_group: 'RESOURCE_GROUP', name: 'MY_APP') do it { should exist } end ``` + ```ruby describe azure_webapp(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}') do it { should exist } @@ -37,7 +39,7 @@ end ## Parameters `resource_group` -: Azure resource group that the targeted resource resides in. `MyResourceGroup`. +: Azure resource group where the targeted resource resides. `name` : Name of the webapp to test. `my_webapp`. @@ -46,15 +48,16 @@ end : The unique resource ID. `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}`. `auth_settings_api_version` -: The endpoint api version for the `auth_settings` property. The latest version will be used unless provided. +: The endpoint API version for the `auth_settings` property. The latest version will be used unless provided. `configuration_api_version` -: The endpoint api version for the `configuration` property. The latest version will be used unless provided. +: The endpoint API version for the `configuration` property. The latest version will be used unless provided. `supported_stacks_api_version` -: The endpoint api version for the `supported_stacks` property. The latest version will be used unless provided. +: The endpoint API version for the `supported_stacks` property. The latest version will be used unless provided. Either one of the parameter sets can be provided for a valid query along with the optional ones: + - `resource_id` - `resource_group` and `name` @@ -64,22 +67,22 @@ Either one of the parameter sets can be provided for a valid query along with th : Authentication/Authorization settings of the interrogated app with [these](https://docs.microsoft.com/en-us/rest/api/appservice/webapps/getauthsettings#siteauthsettings) properties. `configuration` -: Configuration of an app, such as platform version, default documents, virtual applications, always on, etc. For more see [here](https://docs.microsoft.com/en-us/rest/api/appservice/webapps/getconfiguration#siteconfigresource). +: Configuration of an app, such as platform version, default documents, virtual applications, always on, and so on. For more see [here](https://docs.microsoft.com/en-us/rest/api/appservice/webapps/getconfiguration#siteconfigresource). `supported_stacks` : Available application frameworks and their versions with [these](https://docs.microsoft.com/en-us/rest/api/appservice/provider/getavailablestacks#applicationstackcollection) properties. -For properties applicable to all resources, such as `type`, `name`, `id`, `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). +For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`]({{< relref "azure_generic_resource.md#properties" >}}). -Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/appservice/webapps/get#site) for other properties available. -Any attribute in the response may be accessed with the key names separated by dots (`.`), eg. `properties.`. +Also, refer to [Azure documentation](https://docs.microsoft.com/en-us/rest/api/appservice/webapps/get#site) for other properties available. +Any attribute in the response may be accessed with the key names separated by dots (`.`). For example, `properties.`. ## Examples -**Test that a Resource Group has the Specified Webapp and Verify it's Authentication Settings and Platform-specific Security Token Storing are Enabled .** +### Test that a resource group has the specified Webapp and verify it's authentication settings, platform-specific security token storing is enabled ```ruby -describe azure_webapp(resource_group: 'example', name: 'webapp_name') do +describe azure_webapp(resource_group: 'EXAMPLE', name: 'WEBAPP_NAME') do it { should exist } its('auth_settings.properties') { should have_attributes(enabled: true ) } its('configuration.properties') { should have_attributes(tokenStoreEnabled: true) } @@ -88,35 +91,46 @@ end ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. + +### Test webapp to ensure it's using the latest supported version of .NET -### Test Webapp to Ensure it's Using the Latest Supported Version of .NET ```ruby -describe azure_webapp(resource_group: 'example', name: 'webapp_name') do +describe azure_webapp(resource_group: 'EXAMPLE', name: 'WEBAPP_NAME') do it { should be_using_latest('aspnet') } end -``` -### Test Webapp to Ensure it's Using the Latest Supported Version of Python +``` + +### Test webapp to ensure it's using the latest supported version of Python + ```ruby -describe azure_webapp(resource_group: 'example', name: 'webapp_name') do +describe azure_webapp(resource_group: 'EXAMPLE', name: 'WEBAPP_NAME') do it { should be_using_latest('python') } end -``` +``` + ### exists ```ruby -# If we expect a resource to always exist +# If we expect a resource to always exist. -describe azure_webapp(resource_group: 'inspec-rg', name: 'webapp_name') do +describe azure_webapp(resource_group: 'RESOURCE_GROUP', name: 'WEBAPP_NAME') do it { should exist } end -# If we expect a resource to never exist +``` + +### not_exists + +```ruby +# If we expect a resource to never exist. -describe azure_webapp(resource_group: 'inspec-rg', name: 'webapp_name') do +describe azure_webapp(resource_group: 'RESOURCE_GROUP', name: 'WEBAPP_NAME') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_webapps.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_webapps.md index 29e98af3b3..602cdebcc8 100644 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_webapps.md +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/azure_webapps.md @@ -10,27 +10,30 @@ identifier = "inspec/resources/azure/azure_webapps Resource" parent = "inspec/resources/azure" +++ -Use the `azure_webapps` InSpec audit resource to test properties and configuration of multiple Azure web applications. +Use the `azure_webapps` InSpec audit resource to test the properties and configuration of multiple Azure web applications. ## Azure REST API Version, Endpoint, and HTTP Client Parameters -{{% inspec_azure_common_parameters %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_common_parameters.md" >}} -## Installation +## Install -{{% inspec_azure_install %}} +{{< readfile file="content/inspec/resources/reusable/md/inspec_azure_install.md" >}} ## Syntax -An `azure_webapps` resource block returns all webapps, either within a Resource Group (if provided), or within an entire Subscription. +An `azure_webapps` resource block returns all webapps within a resource group (if provided) or an entire subscription. + ```ruby describe azure_webapps do #... end ``` -or + +Or + ```ruby -describe azure_webapps(resource_group: 'my-rg') do +describe azure_webapps(resource_group: 'RESOURCE_GROUP') do #... end ``` @@ -44,7 +47,7 @@ end ## Properties `ids` -: A list of the unique resource ids. +: A list of the unique resource IDs. : **Field**: `id` @@ -63,37 +66,50 @@ end : **Field**: `properties` -{{% inspec_filter_table %}} +{{< note >}} + +{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}} + +{{< /note>}} ## Examples -**Test that an Example Resource Group has the Named Web Application.** +### Test that an example resource group has the named web application ```ruby -describe azure_webapps(resource_group: 'ExampleGroup') do +describe azure_webapps(resource_group: 'EXAMPLEGROUP') do its('names') { should include('my_web_app') } end ``` ## Matchers -This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists -The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches. +The control passes if the filter returns at least one result. Use `should_not` if you expect zero matches. + ```ruby -# If we expect 'ExampleGroup' Resource Group to have at least one web application -describe azure_webapps(resource_group: 'ExampleGroup') do +# If we expect 'EXAMPLEGROUP' resource group to have at least one web application. + +describe azure_webapps(resource_group: 'EXAMPLEGROUP') do it { should exist } end +``` + +### not_exists + +```ruby +# If we expect 'EMPTYEXAMPLEGROUP' resource group to not have any web applications. -# If we expect 'EmptyExampleGroup' Resource Group to not have any web applications -describe azure_webapps(resource_group: 'EmptyExampleGroup') do +describe azure_webapps(resource_group: 'EMPTYEXAMPLEGROUP') do it { should_not exist } end ``` ## Azure Permissions -{{% azure_permissions_service_principal role="contributor" %}} +{{% inspec-azure/azure_permissions_service_principal role="contributor" %}} diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/reusable/index.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/reusable/index.md new file mode 100644 index 0000000000..41de90ae49 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/reusable/index.md @@ -0,0 +1,5 @@ ++++ +headless = true +## headless = true makes this directory a headless bundle. +## See https://gohugo.io/content-management/page-bundles/#headless-bundle ++++ diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/layouts/shortcodes/inspec_azure_common_parameters.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/reusable/md/inspec_azure_common_parameters.md similarity index 100% rename from _vendor/github.com/inspec/inspec-azure/docs-chef-io/layouts/shortcodes/inspec_azure_common_parameters.md rename to _vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/reusable/md/inspec_azure_common_parameters.md diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/reusable/md/inspec_azure_install.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/reusable/md/inspec_azure_install.md new file mode 100644 index 0000000000..3dd26c5fb4 --- /dev/null +++ b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/content/inspec/resources/reusable/md/inspec_azure_install.md @@ -0,0 +1,4 @@ + +This resource is available in the [Chef InSpec Azure resource pack](https://github.com/inspec/inspec-azure). + +For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the [Chef InSpec documentation for the Azure cloud platform](/inspec/cloud/azure/). diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/layouts/shortcodes/azure_permissions_service_principal.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/layouts/shortcodes/inspec-azure/azure_permissions_service_principal.md similarity index 100% rename from _vendor/github.com/inspec/inspec-azure/docs-chef-io/layouts/shortcodes/azure_permissions_service_principal.md rename to _vendor/github.com/inspec/inspec-azure/docs-chef-io/layouts/shortcodes/inspec-azure/azure_permissions_service_principal.md diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/layouts/shortcodes/inspec_azure_install.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/layouts/shortcodes/inspec_azure_install.md deleted file mode 100644 index 29e24e8b46..0000000000 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/layouts/shortcodes/inspec_azure_install.md +++ /dev/null @@ -1,4 +0,0 @@ - -This resource is available in the [Chef InSpec Azure resource pack](https://github.com/inspec/inspec-azure). - -See the [Chef InSpec documentation on cloud platforms](/inspec/platforms/#azure-platform-support-in-inspec) for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack. diff --git a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/layouts/shortcodes/inspec_filter_table.md b/_vendor/github.com/inspec/inspec-azure/docs-chef-io/layouts/shortcodes/inspec_filter_table.md deleted file mode 100644 index 92b235679d..0000000000 --- a/_vendor/github.com/inspec/inspec-azure/docs-chef-io/layouts/shortcodes/inspec_filter_table.md +++ /dev/null @@ -1,8 +0,0 @@ - -
-

Note

-
-

See the documentation on FilterTable for information on using filter criteria on plural resources. -

-
-
diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_api_resources.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_api_resources.md index d0916b040a..91a8f73e7e 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_api_resources.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_api_resources.md @@ -91,4 +91,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_config_map.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_config_map.md index 182df2b5df..2f175bd21f 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_config_map.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_config_map.md @@ -68,4 +68,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_config_maps.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_config_maps.md index 8bf855a9f0..f8a0b3ce23 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_config_maps.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_config_maps.md @@ -69,4 +69,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_container.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_container.md index 37185d5cc7..0feeaec5db 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_container.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_container.md @@ -92,3 +92,7 @@ end it { should_have_command?('COMMAND') } end ``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_containers.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_containers.md index 56ef56e30e..daf4a2bff3 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_containers.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_containers.md @@ -89,4 +89,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_cronjob.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_cronjob.md index 4750716236..246bec988e 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_cronjob.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_cronjob.md @@ -90,4 +90,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_cronjobs.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_cronjobs.md index 36bf691cf2..5f362589f6 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_cronjobs.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_cronjobs.md @@ -79,4 +79,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_daemon_set.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_daemon_set.md index b4df0fabc1..6bd190ccd9 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_daemon_set.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_daemon_set.md @@ -89,4 +89,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_daemon_sets.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_daemon_sets.md index 6e55b02640..5387277b5d 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_daemon_sets.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_daemon_sets.md @@ -79,4 +79,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_deployment.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_deployment.md index d6c475ee9f..49ac4ef355 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_deployment.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_deployment.md @@ -90,4 +90,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_deployments.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_deployments.md index 3ec761483a..807749c69f 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_deployments.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_deployments.md @@ -79,4 +79,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_exec_file.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_exec_file.md index f68798cd81..3005a89ebd 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_exec_file.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_exec_file.md @@ -93,4 +93,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_job.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_job.md index e9f40f4869..43168a24c5 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_job.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_job.md @@ -89,4 +89,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_jobs.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_jobs.md index 9b5672fc10..b6922d1248 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_jobs.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_jobs.md @@ -79,4 +79,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_namespace.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_namespace.md index 17ea0635a1..532bc59e30 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_namespace.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_namespace.md @@ -70,4 +70,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_namespaces.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_namespaces.md index 3f1dc708ff..749bb0553b 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_namespaces.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_namespaces.md @@ -58,4 +58,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_network_policies.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_network_policies.md index 99c5161b84..75c1e72220 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_network_policies.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_network_policies.md @@ -81,4 +81,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_network_policy.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_network_policy.md index faf65b0c62..dcce6eb385 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_network_policy.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_network_policy.md @@ -90,4 +90,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_node.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_node.md index b3b7088f34..b2bc11fd45 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_node.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_node.md @@ -58,7 +58,7 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### have_label diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_nodes.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_nodes.md index 743397ccb4..a713e882fd 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_nodes.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_nodes.md @@ -51,4 +51,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_object.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_object.md index 5292471c22..d2116e7f60 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_object.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_object.md @@ -81,7 +81,7 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} ### have_label diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_objects.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_objects.md index 5527f287b9..963b016b89 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_objects.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_objects.md @@ -72,4 +72,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_pod.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_pod.md index 44d728b89a..0307e37117 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_pod.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_pod.md @@ -66,3 +66,7 @@ describe k8s_pod(namespace: 'NAMESPACE', name: 'NAME') do it { should exist } end ``` + +## Matchers + +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_pods.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_pods.md index bd73b624af..5f00286240 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_pods.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_pods.md @@ -68,4 +68,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_rbac_cluster_role.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_rbac_cluster_role.md index eb23409b0c..d33a065d99 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_rbac_cluster_role.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_rbac_cluster_role.md @@ -91,4 +91,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_rbac_cluster_roles.md b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_rbac_cluster_roles.md index 8c0d28e301..698a136221 100644 --- a/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_rbac_cluster_roles.md +++ b/_vendor/github.com/inspec/inspec-k8s/docs-chef-io/content/inspec/resources/k8s_rbac_cluster_roles.md @@ -84,4 +84,4 @@ end ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/aide_conf.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/aide_conf.md index 3476b94894..a445e65737 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/aide_conf.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/aide_conf.md @@ -15,9 +15,9 @@ Use the `aide_conf` Chef InSpec audit resource to test the rules established for ## Availability -### Installation +### Install -{{% inspec/inspec_installation %}} +{{< readfile file="content/inspec/reusable/md/inspec_installation.md" >}} ### Version @@ -97,4 +97,4 @@ The following examples show how to use this Chef InSpec audit resource. ## Matchers -For a full list of available matchers, please visit our [matchers page](/inspec/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/apache.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/apache.md index 0d568dae05..2e12131d29 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/apache.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/apache.md @@ -21,7 +21,7 @@ Use the `apache` Chef InSpec audit resource to test the state of the Apache serv ## Availability -### Installation +### Install This resource was distributed along with Chef InSpec itself. @@ -76,4 +76,4 @@ The following examples show how to use this Chef InSpec audit resource. ## Matchers -For a full list of available matchers, please visit our [matchers page](/inspec/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/apache_conf.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/apache_conf.md index a785705723..9b2ab4defc 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/apache_conf.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/apache_conf.md @@ -15,9 +15,9 @@ Use the `apache_conf` Chef InSpec audit resource to test the configuration setti ## Availability -### Installation +### Install -{{% inspec/inspec_installation %}} +{{< readfile file="content/inspec/reusable/md/inspec_installation.md" >}} ### Requirements @@ -65,7 +65,8 @@ The following examples show how to use this Chef InSpec audit resource. ## Matchers -For a full list of available matchers, please visit our [matchers page](/inspec/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + This Chef InSpec audit resource matches any service that is listed in the Apache configuration file: its('PidFile') { should_not eq '/var/run/httpd.pid' } diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/apt.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/apt.md index 2f8d5c5129..6febfb3f2d 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/apt.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/apt.md @@ -15,9 +15,9 @@ Use the `apt` Chef InSpec audit resource to verify Apt repositories on the Debia ## Availability -### Installation +### Install -{{% inspec/inspec_installation %}} +{{< readfile file="content/inspec/reusable/md/inspec_installation.md" >}} ### Version @@ -65,7 +65,9 @@ The following examples show how to use this Chef InSpec audit resource. ## Matchers -For a full list of available matchers, please visit our [matchers page](/inspec/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### be_enabled diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/audit_policy.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/audit_policy.md index f5f8a5386f..e2cc55954c 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/audit_policy.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/audit_policy.md @@ -15,9 +15,9 @@ Use the `audit_policy` Chef InSpec audit resource to test auditing policies on t ## Availability -### Installation +### Install -{{% inspec/inspec_installation %}} +{{< readfile file="content/inspec/reusable/md/inspec_installation.md" >}} ### Version @@ -54,4 +54,4 @@ The following examples show how to use this Chef InSpec audit resource. ## Matchers -For a full list of available matchers, please visit our [matchers page](/inspec/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/auditd.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/auditd.md index 6d90aa565b..d02fb8a1c7 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/auditd.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/auditd.md @@ -15,9 +15,9 @@ Use the `auditd` Chef InSpec audit resource to test the rules for logging that e ## Availability -### Installation +### Install -{{% inspec/inspec_installation %}} +{{< readfile file="content/inspec/reusable/md/inspec_installation.md" >}} ### Version @@ -86,4 +86,4 @@ The key filter may be useful in evaluating rules with particular key values: ## Matchers -For a full list of available matchers, please visit our [matchers page](/inspec/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/auditd_conf.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/auditd_conf.md index 23962072e7..1f310dfef9 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/auditd_conf.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/auditd_conf.md @@ -15,9 +15,9 @@ Use the `auditd_conf` Chef InSpec audit resource to test the configuration setti ## Availability -### Installation +### Install -{{% inspec/inspec_installation %}} +{{< readfile file="content/inspec/reusable/md/inspec_installation.md" >}} ### Version @@ -72,7 +72,9 @@ The following examples show how to use this Chef InSpec audit resource. ## Matchers -For a full list of available matchers, please visit our [matchers page](/inspec/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### `cmp` diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_ad_user.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_ad_user.md index 5ce890e3aa..0752b159d9 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_ad_user.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_ad_user.md @@ -32,7 +32,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -232,7 +232,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_ad_users.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_ad_users.md index 1e9d37124b..7e1880896e 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_ad_users.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_ad_users.md @@ -31,7 +31,7 @@ please open an issue or submit a pull request using the updated version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -119,7 +119,9 @@ The userTypes property provides a list of all User Types for all users. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_aks_cluster.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_aks_cluster.md index 4e928b44c7..24c79217ff 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_aks_cluster.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_aks_cluster.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -119,7 +119,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_aks_clusters.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_aks_clusters.md index 3a85f73435..e6b9c519d8 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_aks_clusters.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_aks_clusters.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -69,7 +69,9 @@ The name of the AKS Cluster ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_cosmosdb_database_account.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_cosmosdb_database_account.md index 94a46310b5..81e4a9e98c 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_cosmosdb_database_account.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_cosmosdb_database_account.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -128,7 +128,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_event_hub_authorization_rule.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_event_hub_authorization_rule.md index 5fb6e74923..d265e3a429 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_event_hub_authorization_rule.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_event_hub_authorization_rule.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -113,7 +113,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_event_hub_event_hub.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_event_hub_event_hub.md index c86e843b69..b3c4e0334e 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_event_hub_event_hub.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_event_hub_event_hub.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -112,7 +112,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_event_hub_namespace.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_event_hub_namespace.md index 9f30872909..866a4bdaea 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_event_hub_namespace.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_event_hub_namespace.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -127,7 +127,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_iothub.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_iothub.md index 9b96fc1866..ea90d4892c 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_iothub.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_iothub.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -133,7 +133,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_iothub_event_hub_consumer_group.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_iothub_event_hub_consumer_group.md index 6823ad40f4..57b3556d15 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_iothub_event_hub_consumer_group.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_iothub_event_hub_consumer_group.md @@ -29,7 +29,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -119,7 +119,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_iothub_event_hub_consumer_groups.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_iothub_event_hub_consumer_groups.md index 3dead3273e..4b25f86edc 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_iothub_event_hub_consumer_groups.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_iothub_event_hub_consumer_groups.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -122,7 +122,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault.md index 752f9ce356..f3ba9d3e3f 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -122,7 +122,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_key.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_key.md index 26a2eaa6b0..7bb1521169 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_key.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_key.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -117,7 +117,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_keys.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_keys.md index d4e522cb7d..56fc8dac85 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_keys.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_keys.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -103,7 +103,9 @@ Resource tags applied to the Key. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_secret.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_secret.md index ff70dcdaad..6595c0a0ae 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_secret.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_secret.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -130,7 +130,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_secrets.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_secrets.md index 3e563c8eb6..8d55c619f8 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_secrets.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vault_secrets.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -107,7 +107,9 @@ Resource tags applied to the Key. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vaults.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vaults.md index b773b9b2fc..73c26983b6 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vaults.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_key_vaults.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -121,7 +121,9 @@ A collection of additional configuration properties related to the Key Vault, e. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_load_balancer.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_load_balancer.md index b5d010ba41..0e935de785 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_load_balancer.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_load_balancer.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -126,7 +126,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_load_balancers.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_load_balancers.md index 06783d4eab..2cbd3f930a 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_load_balancers.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_load_balancers.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -131,7 +131,9 @@ The type of Resource, typically `Microsoft.Network/loadBalancers`. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_locks.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_locks.md index 22de20cc3d..97804aff1d 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_locks.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_locks.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -70,7 +70,9 @@ The following examples show how to use this InSpec audit resource. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_management_group.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_management_group.md index 2e1f575692..9482121d34 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_management_group.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_management_group.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -251,7 +251,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_management_groups.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_management_groups.md index b73240dd59..3b5979fc53 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_management_groups.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_management_groups.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_activity_log_alert.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_activity_log_alert.md index d398d209b3..dec1edf782 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_activity_log_alert.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_activity_log_alert.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -146,7 +146,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_activity_log_alerts.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_activity_log_alerts.md index 045b9328c4..c062205f45 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_activity_log_alerts.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_activity_log_alerts.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -70,7 +70,9 @@ The name of the Activity Log Alert ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_log_profile.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_log_profile.md index 3a3d736db1..db691e7953 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_log_profile.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_log_profile.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -108,7 +108,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_log_profiles.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_log_profiles.md index fc92b939c3..903bd2c5ce 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_log_profiles.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_monitor_log_profiles.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -69,7 +69,9 @@ The name of the Log Profile ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_database.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_database.md index 698179f155..7df5f743a8 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_database.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_database.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -113,7 +113,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_databases.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_databases.md index 2ab3a29a9f..dc3e00ffa3 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_databases.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_databases.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -111,7 +111,9 @@ A collection of additional configuration properties related to the MySQL Databas ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_server.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_server.md index 99f86c05ce..0619aa0679 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_server.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_server.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -126,7 +126,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_servers.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_servers.md index 3ee988a870..5144936364 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_servers.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_mysql_servers.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -131,7 +131,9 @@ The type of Resource, typically `Microsoft.DBforMySQL/servers`. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_interface.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_interface.md index f26eec141c..1f262f526f 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_interface.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_interface.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -130,7 +130,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_interfaces.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_interfaces.md index 99b40c092e..5ef285f8d9 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_interfaces.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_interfaces.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -127,7 +127,9 @@ The type of Resource, typically `Microsoft.Network/networkInterfaces`. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_security_group.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_security_group.md index ff5c75604f..ea26ecece7 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_security_group.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_security_group.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -136,7 +136,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_security_groups.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_security_groups.md index edad524781..ea724ecae5 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_security_groups.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_security_groups.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -70,7 +70,9 @@ The name of the Network Security Group ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_watcher.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_watcher.md index 0e42e5d498..6556a67501 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_watcher.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_watcher.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -103,7 +103,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_watchers.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_watchers.md index 63cfb3cfe4..195cec9b89 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_watchers.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_network_watchers.md @@ -29,7 +29,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -71,7 +71,9 @@ The name of the Network Watcher ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_database.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_database.md index 87e5059387..524a38bc59 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_database.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_database.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -113,7 +113,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_databases.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_databases.md index 4a2b86b19e..0c5ed33b6c 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_databases.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_databases.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -103,7 +103,9 @@ A collection of additional configuration properties related to the PostgreSQL Da ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_server.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_server.md index 6636d2f663..40de7f3f01 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_server.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_server.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -121,7 +121,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_servers.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_servers.md index 082a7856da..42598a84cf 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_servers.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_postgresql_servers.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -126,7 +126,9 @@ The type of Resource, typically `Microsoft.DBforPostgreSQL/servers`. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_resource_groups.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_resource_groups.md index 480fa0a047..a9d9315210 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_resource_groups.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_resource_groups.md @@ -32,7 +32,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -117,7 +117,9 @@ The tags property provides a list of all the Resource Group tags. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_role_definition.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_role_definition.md index 25dcc05a08..69ff382575 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_role_definition.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_role_definition.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -123,7 +123,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_role_definitions.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_role_definitions.md index d95499e9e9..f864d9c453 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_role_definitions.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_role_definitions.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -108,7 +108,9 @@ Additional properties available for the Roles. May be accessed with dot notation ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_security_center_policies.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_security_center_policies.md index 4c7d936481..d0b49c9721 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_security_center_policies.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_security_center_policies.md @@ -31,7 +31,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -88,7 +88,9 @@ name. This is a string value. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_security_center_policy.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_security_center_policy.md index 8a09e7f35f..320dd54736 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_security_center_policy.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_security_center_policy.md @@ -35,7 +35,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -273,7 +273,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_database.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_database.md index c1f497a4b8..02fcdac56e 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_database.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_database.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -128,7 +128,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_databases.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_databases.md index 9a68ce00b3..8ac26109d8 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_databases.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_databases.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -128,7 +128,9 @@ A collection of additional configuration properties related to the SQL Database, ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_server.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_server.md index 2bb603db04..40c7659f9d 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_server.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_server.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -126,7 +126,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_servers.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_servers.md index c3dc1a5810..3804ab0258 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_servers.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_sql_servers.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -131,7 +131,9 @@ The type of Resource, typically `Microsoft.Sql/servers`. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_storage_account_blob_container.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_storage_account_blob_container.md index cc891ef1c5..7fdfed47be 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_storage_account_blob_container.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_storage_account_blob_container.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -133,7 +133,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_storage_account_blob_containers.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_storage_account_blob_containers.md index e438c4e959..e4c13711f0 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_storage_account_blob_containers.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_storage_account_blob_containers.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -100,7 +100,9 @@ The etag of the Resource, e.g. `\"0x8D592D74CC20EBA\"`. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_subnet.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_subnet.md index b0ab59c1b9..3f096e5042 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_subnet.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_subnet.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -165,7 +165,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_subnets.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_subnets.md index 2d1d2ed86a..19d14d7d89 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_subnets.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_subnets.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -105,7 +105,9 @@ Gives a list of all the subnet names in the virtual network. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_subscription.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_subscription.md index 1c9e2cbb79..35f46dcd02 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_subscription.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_subscription.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -89,7 +89,9 @@ An array of locations available in this subscription. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machine.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machine.md index 8ea10ff800..686840b06f 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machine.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machine.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -191,7 +191,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machine_disk.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machine_disk.md index 16b01ae3a5..fa5663b990 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machine_disk.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machine_disk.md @@ -29,7 +29,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -167,7 +167,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machine_disks.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machine_disks.md index f6314553a5..c5e9d26712 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machine_disks.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machine_disks.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -81,7 +81,9 @@ The following examples show how to use this InSpec audit resource. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machines.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machines.md index 724f142699..39468e702b 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machines.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_machines.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -132,7 +132,9 @@ Gives a list of all the virtual machine names in the resource group. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_network.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_network.md index 116b375d89..13b3cd3b5f 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_network.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_network.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -200,7 +200,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_networks.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_networks.md index 45897ece08..0144d3927c 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_networks.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_virtual_networks.md @@ -28,7 +28,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -99,7 +99,9 @@ Gives a list of all the virtual network names in the resource group. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_webapp.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_webapp.md index e660d0cfca..2a25b99479 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_webapp.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_webapp.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -130,7 +130,9 @@ requests are always welcome. ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### using_latest?(stack) diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_webapps.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_webapps.md index ec15f0ca2b..8731d1e36b 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_webapps.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/azurerm_webapps.md @@ -27,7 +27,7 @@ version. ## Availability -### Installation +### Install This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the @@ -69,7 +69,9 @@ The name of the Webapp ## Matchers -{{% inspec/inspec_matchers_link %}} +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exists diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bash.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bash.md index b419d27af3..6e22c71365 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bash.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bash.md @@ -15,9 +15,9 @@ Use the `bash` Chef InSpec audit resource to test an arbitrary command that is r ## Availability -### Installation +### Install -{{% inspec/inspec_installation %}} +{{< readfile file="content/inspec/reusable/md/inspec_installation.md" >}} ### Version @@ -68,7 +68,9 @@ The `stdout` property returns the results of the command as returned in standard ## Matchers -For a full list of available matchers, please visit our [matchers page](/inspec/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bond.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bond.md index 4a2765b863..1131c550db 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bond.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bond.md @@ -15,9 +15,9 @@ Use the `bond` Chef InSpec audit resource to test a logical, bonded network inte ## Availability -### Installation +### Install -{{% inspec/inspec_installation %}} +{{< readfile file="content/inspec/reusable/md/inspec_installation.md" >}} ### Version @@ -83,7 +83,9 @@ The `params` property returns arbitrary parameters for the bonded network interf ## Matchers -For a full list of available matchers, please visit our [matchers page](/inspec/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bridge.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bridge.md index a4acf6e25e..39e6562808 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bridge.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bridge.md @@ -15,9 +15,9 @@ Use the `bridge` Chef InSpec audit resource to test basic network bridge propert ## Availability -### Installation +### Install -{{% inspec/inspec_installation %}} +{{< readfile file="content/inspec/reusable/md/inspec_installation.md" >}} ### Version @@ -45,7 +45,9 @@ The `interfaces` property returns the named interfaces. ## Matchers -For a full list of available matchers, please visit our [matchers page](/inspec/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### exist diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bsd_service.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bsd_service.md index 4fe9a6afdf..6a42b084fe 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bsd_service.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/bsd_service.md @@ -15,9 +15,9 @@ Use the `bsd_service` Chef InSpec audit resource to test a service using a Berke ## Availability -### Installation +### Install -{{% inspec/inspec_installation %}} +{{< readfile file="content/inspec/reusable/md/inspec_installation.md" >}} ### Version @@ -56,7 +56,9 @@ All properties available to the [`service`](/inspec/resources/service/) resource ## Matchers -For a full list of available matchers, please visit our [matchers page](/inspec/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} + +This resource has the following special matchers. ### be_enabled diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/cassandradb_conf.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/cassandradb_conf.md index 0ac0946ad7..08f3b28171 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/cassandradb_conf.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/cassandradb_conf.md @@ -15,7 +15,7 @@ Use the `cassandradb_conf` Chef InSpec audit resource to test the configuration ## Installation -{{% inspec/inspec_installation %}} +{{< readfile file="content/inspec/reusable/md/inspec_installation.md" >}} ## Requirements @@ -42,4 +42,4 @@ The following examples show how to use this Chef InSpec audit resource. ## Matchers -For a full list of available matchers, please visit our [matchers page](/inspec/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/cassandradb_session.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/cassandradb_session.md index be08c85740..5ada3236f0 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/cassandradb_session.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/cassandradb_session.md @@ -15,9 +15,9 @@ Use the `cassandradb_session` Chef InSpec audit resource to test Cassandra Query ## Availability -### Installation +### Install -{{% inspec/inspec_installation %}} +{{< readfile file="content/inspec/reusable/md/inspec_installation.md" >}} ## Syntax @@ -73,4 +73,4 @@ end ## Matchers -For a full list of available matchers, please visit our [matchers page](/inspec/matchers/). +{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}} diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/cgroup.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/cgroup.md index c45a53a555..4029d0b984 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/cgroup.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/cgroup.md @@ -15,7 +15,7 @@ Use the `cgroup` Chef InSpec audit resource to test the different parameters val ## Availability -### Installation +### Install This resource is distributed with Chef InSpec. diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/chocolatey_package.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/chocolatey_package.md index b885c9821e..283d7648fb 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/chocolatey_package.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/chocolatey_package.md @@ -15,9 +15,9 @@ Use the `chocolatey_package` Chef InSpec audit resource to test if the named [Ch ## Availability -### Installation +### Install -{{% inspec/inspec_installation %}} +{{< readfile file="content/inspec/reusable/md/inspec_installation.md" >}} ### Version diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/chrony_conf.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/chrony_conf.md index a5094ffdaf..1dd8575e3b 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/chrony_conf.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/resources/chrony_conf.md @@ -15,9 +15,9 @@ Use the `chrony_conf` Chef InSpec audit resource to test the synchronization set ## Availability -### Installation +### Install -{{% inspec/inspec_installation %}} +{{< readfile file="content/inspec/reusable/md/inspec_installation.md" >}}