Skip to content

Commit

Permalink
Merge pull request #548 from inspec/im/fix_docs
Browse files Browse the repository at this point in the history 
Minor docs fixes
  • Loading branch information
@IanMadd
IanMadd authored Nov 11, 2021
2 parents c4107be + 5a51886 commit bc4b0a0
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 24 deletions.
44 changes: 22 additions & 22 deletions docs/resources/azure_policy_assignments.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,28 +34,28 @@ end

Please review the [Azure documentation](https://docs.microsoft.com/en-us/rest/api/policy/policyassignments/list#policyassignment) for a full description of the available properties.

| Property | Filter | Description |
|----------------------|---------------------|------------------------------------------------------------------------------------------|
| ids | id | The ID of this policy assignment |
| types | type | The Azure resource type |
| names | name | The names of the policy assignments |
| locations | location | The locations of the policy assignments |
| tags | tags | The tags of the policy assignments |
| displayNames | displayName | The display names of the policy assignments |
| policyDefinitionIds | policyDefinitionId | The IDs of the policies being assigned by these policy assignments |
| scopes | scope | The scope of the policy assignments (which resources they are being attached to) |
| notScopes | notScopes | The scopes which are excluded from these policy assignments (blocks inheritance) |
| parameters | parameters | The override parameters passed to the base policy by this assignment |
| enforcementMode | enforcementModes | The enforcement modes of these policy assignments |
| assignedBys | assignedBy | The IDs that assigned these policies |
| parameterScopes | parameterScopes | Unknown - no data observed in this field in the wild |
| created_bys | created_by | The IDs that created these policy assignments |
| createdOns | createdOn | The dates these policy assignments were created (as a Ruby Time object) |
| updatedBys | updatedBy | The IDs that updated these policy assignments |
| updatedOns | updatedOn | The dates these policy assignments were updated (as a Ruby Time object) |
| identityPrincipalIds | identityPrincipalId | The principal IDs of the associated managed identities |
| identityTenantIds | identityTenantId | The tenant IDs of the associated managed identities |
| identityTypes | identityType | The identity types of the associated managed identities |
| Property | Description | Filter |
|----------------------|------------------------------------------------------------------------------------------|---------------------|
| ids | The ID of this policy assignment | id |
| types | The Azure resource type | type |
| names | The names of the policy assignments | name |
| locations | The locations of the policy assignments | location |
| tags | The tags of the policy assignments | tags |
| displayNames | The display names of the policy assignments | displayName |
| policyDefinitionIds | The IDs of the policies being assigned by these policy assignments | policyDefinitionId |
| scopes | The scope of the policy assignments (which resources they are being attached to) | scope |
| notScopes | The scopes which are excluded from these policy assignments (blocks inheritance) | notScopes |
| parameters | The override parameters passed to the base policy by this assignment | parameters |
| enforcementMode | The enforcement modes of these policy assignments | enforcementModes |
| assignedBys | The IDs that assigned these policies | assignedBy |
| parameterScopes | Unknown - no data observed in this field in the wild | parameterScopes |
| created_bys | The IDs that created these policy assignments | created_by |
| createdOns | The dates these policy assignments were created (as a Ruby Time object) | createdOn |
| updatedBys | The IDs that updated these policy assignments | updatedBy |
| updatedOns | The dates these policy assignments were updated (as a Ruby Time object) | updatedOn |
| identityPrincipalIds | The principal IDs of the associated managed identities | identityPrincipalId |
| identityTenantIds | The tenant IDs of the associated managed identities | identityTenantId |
| identityTypes | The identity types of the associated managed identities | identityType |

## Examples

Expand Down
6 changes: 4 additions & 2 deletions docs/resources/azure_virtual_network_gateway_connections.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This resource is available in the [InSpec Azure resource pack](https://github.co

## Syntax

An `azure_virtual_network_gateway_connections` resource block returns all Azure Virtual Network Gateway <!-- markdownlint-configure-file { "MD013": { "line_length": 100 } } -->connections within a project.
An `azure_virtual_network_gateway_connections` resource block returns all Azure Virtual Network Gateway connections within a project.

```ruby
describe azure_virtual_network_gateway_connections(resource_group: 'RESOURCE_GROUP') do
Expand All @@ -30,11 +30,13 @@ end
```

## Parameters

| Name | Description |
|----------------|----------------------------------------------------------------|
| resource_group | Azure resource group name where the targeted resource resides. |

The parameter set should be provided for a valid query:

- `resource_group`

## Properties
Expand All @@ -51,7 +53,7 @@ The parameter set should be provided for a valid query:
| connectionTypes | A list of gateway connection types. | `connectionType`|
| connectionProtocols | A list of connection protocols used for this connection. | `connectionProtocol`|
| useLocalAzureIpAddresses | A list of private local Azure IPs for the connection. | `datacenterManagementServerName`|
| ipsecPolicies | A list of all The IPSec Policies to be considered by this connection. | `ipsecPolicies` | | `description` |
| ipsecPolicies | A list of all The IPSec Policies to be considered by this connection. | `ipsecPolicies` |

<superscript>*</superscript> 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.

Expand Down

0 comments on commit bc4b0a0

Please sign in to comment.