Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reorganize reusable text files #722

Merged
merged 3 commits into from
Jan 22, 2024
Merged

Reorganize reusable text files #722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
64d93cd
Reorganize reusable text files
IanMadd Dec 20, 2023
a18f34c
Update archetype
IanMadd Dec 21, 2023
c4d84e5
Additional formatting
IanMadd Dec 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs-chef-io/archetypes/resource.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ Use the `{{ .Name }}` Chef InSpec audit resource to test properties of...

## 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

Expand Down Expand Up @@ -48,15 +48,15 @@ end

## Examples

**EXAMPLE DESCRIPTION**
EXAMPLE DESCRIPTION

```ruby
describe {{ .Name }} do

end
```

**EXAMPLE DESCRIPTION**
EXAMPLE DESCRIPTION

```ruby
describe {{ .Name }} do
Expand All @@ -66,7 +66,7 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

## Azure Permissions

Expand Down
10 changes: 6 additions & 4 deletions docs-chef-io/content/inspec/resources/azure_active_directory_domain_service.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Use the `azure_active_directory_domain_service` InSpec audit resource to test th

## 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

Expand Down Expand Up @@ -95,7 +95,9 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

This resource has the following special matchers.

### exists

Expand Down
16 changes: 11 additions & 5 deletions docs-chef-io/content/inspec/resources/azure_active_directory_domain_services.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Use the `azure_active_directory_domain_services` InSpec audit resource to test t

## 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

Expand Down Expand Up @@ -110,7 +110,11 @@ 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

Expand Down Expand Up @@ -142,7 +146,9 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

This resource has the following special matchers.

### exists

Expand Down
10 changes: 6 additions & 4 deletions docs-chef-io/content/inspec/resources/azure_active_directory_object.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Use the `azure_active_directory_object` 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

Expand Down Expand Up @@ -155,7 +155,9 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

This resource has the following special matchers.

### exists

Expand Down
18 changes: 12 additions & 6 deletions docs-chef-io/content/inspec/resources/azure_active_directory_objects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Use the `azure_active_directory_objects` 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

Expand All @@ -41,7 +41,11 @@ 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

Expand All @@ -59,7 +63,9 @@ This resource does not require any parameters.

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

This resource has the following special matchers.

### exists

Expand All @@ -85,4 +91,4 @@ end

## Azure Permissions

{{% azure_permissions_service_principal role="contributor" %}}
{{% inspec-azure/azure_permissions_service_principal role="contributor" %}}
10 changes: 5 additions & 5 deletions docs-chef-io/content/inspec/resources/azure_aks_cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Use the `azure_aks_cluster` InSpec audit resource to test the properties of an 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

Expand Down Expand Up @@ -117,7 +117,7 @@ describe azure_aks_cluster('RESOURCE_GROUP', name: 'CLUSTER_NAME') do
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

Expand Down Expand Up @@ -145,4 +145,4 @@ end

## Azure Permissions

{{% azure_permissions_service_principal role="contributor" %}}
{{% inspec-azure/azure_permissions_service_principal role="contributor" %}}
18 changes: 12 additions & 6 deletions docs-chef-io/content/inspec/resources/azure_aks_clusters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Use the `azure_aks_clusters` InSpec audit resource to test the properties and co

## 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

Expand Down Expand Up @@ -71,7 +71,11 @@ end

: **Field**: `properties`

{{% inspec_filter_table %}}
{{< note >}}

{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}}

{{< /note>}}

## Examples

Expand All @@ -85,7 +89,9 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

This resource has the following special matchers.

### exists

Expand All @@ -111,4 +117,4 @@ end

## Azure Permissions

{{% azure_permissions_service_principal role="contributor" %}}
{{% inspec-azure/azure_permissions_service_principal role="contributor" %}}
10 changes: 5 additions & 5 deletions docs-chef-io/content/inspec/resources/azure_api_management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Use the `azure_api_management` InSpec audit resource to test the properties and

## 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

Expand Down Expand Up @@ -88,7 +88,7 @@ azure_api_managements.ids.each do |resource_id|
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

Expand Down Expand Up @@ -116,4 +116,4 @@ end

## Azure Permissions

{{% azure_permissions_service_principal role="contributor" %}}
{{% inspec-azure/azure_permissions_service_principal role="contributor" %}}
18 changes: 12 additions & 6 deletions docs-chef-io/content/inspec/resources/azure_api_managements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Use the `azure_api_managements` InSpec audit resource to test the properties and

## 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

Expand Down Expand Up @@ -76,7 +76,11 @@ end

: **Field**: `properties`

{{% inspec_filter_table %}}
{{< note >}}

{{< readfile file="content/inspec/reusable/md/inspec_filter_table.md" >}}

{{< /note>}}

## Examples

Expand All @@ -99,7 +103,9 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

This resource has the following special matchers.

### exists

Expand All @@ -125,4 +131,4 @@ end

## Azure Permissions

{{% azure_permissions_service_principal role="contributor" %}}
{{% inspec-azure/azure_permissions_service_principal role="contributor" %}}
10 changes: 5 additions & 5 deletions docs-chef-io/content/inspec/resources/azure_application_gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Use the `azure_application_gateway` 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

Expand Down Expand Up @@ -84,7 +84,7 @@ describe azure_application_gateway(resource_id: '/subscriptions/{subscriptionId}
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

Expand Down Expand Up @@ -112,4 +112,4 @@ end

## Azure Permissions

{{% azure_permissions_service_principal role="contributor" %}}
{{% inspec-azure/azure_permissions_service_principal role="contributor" %}}
Loading