Skip to content

Commit

Permalink
doc edits
Browse files Browse the repository at this point in the history
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
  • Loading branch information
IanMadd committed Mar 11, 2022
1 parent 7265c5e commit 232708a
Show file tree
Hide file tree
Showing 4 changed files with 216 additions and 194 deletions.
103 changes: 103 additions & 0 deletions docs-chef-io/content/inspec/resources/azure_synapse_workspace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
+++
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 properties related to an Azure Synapse workspace.

## Azure REST API Version, Endpoint, and HTTP Client Parameters

{{% inspec_azure_common_parameters %}}

## Installation

{{% inspec_azure_install %}}

## 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 that the targeted resource resides in.

## 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`, `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 is provisioned successfully.**

```ruby
describe azure_synapse_workspace(resource_group: 'RESOURCE_GROUP', name: 'SYNAPSE_WORKSPACE_NAME') do
its('properties.provisioningState') { should eq 'Succeeded' }
end
```

## Matchers

{{% inspec_matchers_link %}}

### exists

```ruby
# If a Synapse workspaces is found it will exist

describe azure_synapse_workspace(resource_group: 'RESOURCE_GROUP', name: 'SYNAPSE_WORKSPACE_NAME') do
it { should exist }
end
# if Synapse workspaces is 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

{{% azure_permissions_service_principal role="reader" %}}
113 changes: 113 additions & 0 deletions docs-chef-io/content/inspec/resources/azure_synapse_workspaces.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
+++
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 properties related to all Azure Synapse workspaces.

## Azure REST API Version, Endpoint, and HTTP Client Parameters

{{% inspec_azure_common_parameters %}}

## Installation

{{% inspec_azure_install %}}

## 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 that the targeted resource resides in.

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

{{% inspec_filter_table %}}

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

{{% inspec_matchers_link %}}

### 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
# Should exist if the filter returns at least one Synapse workspaces

describe azure_synapse_workspaces(resource_group: 'RESOURCE_GROUP') do
it { should exist }
end
```

## Azure Permissions

{{% azure_permissions_service_principal role="reader" %}}
99 changes: 0 additions & 99 deletions docs-chef-io/resources/azure_synapse_workspace.md

This file was deleted.

Loading

0 comments on commit 232708a

Please sign in to comment.