-
Notifications
You must be signed in to change notification settings - Fork 4.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New Data Source:
azurerm_automation_runbook
- (#26359)
* automation runbook data source v1 * runbook data source tests and registration * pr checks * fmt
- Loading branch information
Showing
4 changed files
with
278 additions
and
0 deletions.
There are no files selected for viewing
170 changes: 170 additions & 0 deletions
170
internal/services/automation/automation_runbook_data_source.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,170 @@ | ||
// Copyright (c) HashiCorp, Inc. | ||
// SPDX-License-Identifier: MPL-2.0 | ||
|
||
package automation | ||
|
||
import ( | ||
"context" | ||
"fmt" | ||
"time" | ||
|
||
"github.com/hashicorp/go-azure-helpers/lang/pointer" | ||
"github.com/hashicorp/go-azure-helpers/lang/response" | ||
"github.com/hashicorp/go-azure-helpers/resourcemanager/commonschema" | ||
"github.com/hashicorp/go-azure-helpers/resourcemanager/location" | ||
"github.com/hashicorp/go-azure-sdk/resource-manager/automation/2023-11-01/runbook" | ||
"github.com/hashicorp/terraform-provider-azurerm/internal/sdk" | ||
"github.com/hashicorp/terraform-provider-azurerm/internal/services/automation/validate" | ||
"github.com/hashicorp/terraform-provider-azurerm/internal/tf/pluginsdk" | ||
) | ||
|
||
type AutomationRunbookDataSource struct{} | ||
|
||
type AutomationRunbookDataSourceModel struct { | ||
RunbookName string `tfschema:"name"` | ||
AutomationAccountName string `tfschema:"automation_account_name"` | ||
ResourceGroupName string `tfschema:"resource_group_name"` | ||
Location string `tfschema:"location"` | ||
Description string `tfschema:"description"` | ||
LogProgress bool `tfschema:"log_progress"` | ||
LogVerbose bool `tfschema:"log_verbose"` | ||
RunbookType string `tfschema:"runbook_type"` | ||
LogActivityTrace int64 `tfschema:"log_activity_trace_level"` | ||
Content string `tfschema:"content"` | ||
Tags map[string]string `tfschema:"tags "` | ||
} | ||
|
||
var _ sdk.DataSource = AutomationRunbookDataSource{} | ||
|
||
func (d AutomationRunbookDataSource) Arguments() map[string]*pluginsdk.Schema { | ||
return map[string]*pluginsdk.Schema{ | ||
"name": { | ||
Type: pluginsdk.TypeString, | ||
Required: true, | ||
ValidateFunc: validate.RunbookName(), | ||
}, | ||
|
||
"automation_account_name": { | ||
Type: pluginsdk.TypeString, | ||
Required: true, | ||
ValidateFunc: validate.AutomationAccount(), | ||
}, | ||
|
||
"resource_group_name": commonschema.ResourceGroupNameForDataSource(), | ||
} | ||
} | ||
|
||
func (d AutomationRunbookDataSource) Attributes() map[string]*pluginsdk.Schema { | ||
return map[string]*pluginsdk.Schema{ | ||
"location": commonschema.LocationComputed(), | ||
|
||
"description": { | ||
Type: pluginsdk.TypeString, | ||
Computed: true, | ||
}, | ||
|
||
"log_progress": { | ||
Type: pluginsdk.TypeBool, | ||
Computed: true, | ||
}, | ||
|
||
"log_verbose": { | ||
Type: pluginsdk.TypeBool, | ||
Computed: true, | ||
}, | ||
|
||
"runbook_type": { | ||
Type: pluginsdk.TypeString, | ||
Computed: true, | ||
}, | ||
|
||
"log_activity_trace_level": { | ||
Type: pluginsdk.TypeInt, | ||
Computed: true, | ||
}, | ||
|
||
"content": { | ||
Type: pluginsdk.TypeString, | ||
Computed: true, | ||
}, | ||
|
||
"tags": commonschema.TagsDataSource(), | ||
} | ||
} | ||
|
||
func (d AutomationRunbookDataSource) ModelObject() interface{} { | ||
return &AutomationRunbookDataSourceModel{} | ||
} | ||
|
||
func (d AutomationRunbookDataSource) ResourceType() string { | ||
return "azurerm_automation_runbook" | ||
} | ||
|
||
func (d AutomationRunbookDataSource) Read() sdk.ResourceFunc { | ||
return sdk.ResourceFunc{ | ||
Timeout: 5 * time.Minute, | ||
Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error { | ||
client := metadata.Client.Automation.Runbook | ||
subscriptionId := metadata.Client.Account.SubscriptionId | ||
|
||
var state AutomationRunbookDataSourceModel | ||
if err := metadata.Decode(&state); err != nil { | ||
return err | ||
} | ||
|
||
id := runbook.NewRunbookID(subscriptionId, state.ResourceGroupName, state.AutomationAccountName, state.RunbookName) | ||
|
||
resp, err := client.Get(ctx, id) | ||
if err != nil { | ||
if response.WasNotFound(resp.HttpResponse) { | ||
return fmt.Errorf("%s was not found", id) | ||
} | ||
return fmt.Errorf("retrieving %s: %+v", id, err) | ||
} | ||
|
||
contentResp, err := client.GetContent(ctx, id) | ||
if err != nil { | ||
if !response.WasNotFound(contentResp.HttpResponse) { | ||
return fmt.Errorf("retrieving runbook content %s: %+v", id, err) | ||
} | ||
} | ||
|
||
model := resp.Model | ||
if model == nil { | ||
return fmt.Errorf("retrieving %s: model was nil", id) | ||
} | ||
|
||
state.Location = location.NormalizeNilable(model.Location) | ||
|
||
if model.Properties.Description != nil { | ||
state.Description = pointer.From(model.Properties.Description) | ||
} | ||
|
||
if model.Properties.LogProgress != nil { | ||
state.LogProgress = pointer.From(model.Properties.LogProgress) | ||
} | ||
|
||
if model.Properties.RunbookType != nil { | ||
state.RunbookType = string(pointer.From(model.Properties.RunbookType)) | ||
} | ||
|
||
if model.Properties.LogVerbose != nil { | ||
state.LogVerbose = pointer.From(model.Properties.LogVerbose) | ||
} | ||
|
||
if model.Properties.LogActivityTrace != nil { | ||
state.LogActivityTrace = pointer.From(model.Properties.LogActivityTrace) | ||
} | ||
|
||
if contentResp.Model != nil { | ||
state.Content = string(pointer.From(contentResp.Model)) | ||
} | ||
|
||
state.Tags = pointer.From(model.Tags) | ||
|
||
metadata.SetID(id) | ||
|
||
return metadata.Encode(&state) | ||
}, | ||
} | ||
} |
44 changes: 44 additions & 0 deletions
44
internal/services/automation/automation_runbook_data_source_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
// Copyright (c) HashiCorp, Inc. | ||
// SPDX-License-Identifier: MPL-2.0 | ||
|
||
package automation_test | ||
|
||
import ( | ||
"fmt" | ||
"testing" | ||
|
||
"github.com/hashicorp/go-azure-helpers/resourcemanager/location" | ||
"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance" | ||
"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance/check" | ||
) | ||
|
||
type AutomationRunbookDataSource struct{} | ||
|
||
func TestAccAutomationRunbookDataSource_basic(t *testing.T) { | ||
data := acceptance.BuildTestData(t, "data.azurerm_automation_runbook", "test") | ||
r := AutomationRunbookDataSource{} | ||
|
||
data.DataSourceTest(t, []acceptance.TestStep{ | ||
{ | ||
Config: r.basic(data), | ||
Check: acceptance.ComposeTestCheckFunc( | ||
check.That(data.ResourceName).Key("location").HasValue(location.Normalize(data.Locations.Primary)), | ||
check.That(data.ResourceName).Key("runbook_type").HasValue("PowerShell"), | ||
check.That(data.ResourceName).Key("content").HasValue("# Some test content\n# for Terraform acceptance test\n"), | ||
), | ||
}, | ||
}) | ||
} | ||
|
||
func (AutomationRunbookDataSource) basic(data acceptance.TestData) string { | ||
template := AutomationRunbookResource{}.PSWithContent(data) | ||
return fmt.Sprintf(` | ||
%s | ||
data "azurerm_automation_runbook" "test" { | ||
name = azurerm_automation_runbook.test.name | ||
automation_account_name = azurerm_automation_account.test.name | ||
resource_group_name = azurerm_resource_group.test.name | ||
} | ||
`, template) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
--- | ||
subcategory: "Automation" | ||
layout: "azurerm" | ||
page_title: "Azure Resource Manager: azurerm_automation_runbook" | ||
description: |- | ||
Gets information about an existing Automation Runbook. | ||
--- | ||
|
||
# Data Source: azurerm_automation_runbook | ||
|
||
Use this data source to access information about an existing Automation Runbook. | ||
|
||
## Example Usage | ||
|
||
```hcl | ||
data "azurerm_automation_runbook" "example" { | ||
name = "existing-runbook" | ||
resource_group_name = "existing" | ||
automation_account_name = "existing-automation" | ||
} | ||
output "id" { | ||
value = data.azurerm_automation_runbook.example.id | ||
} | ||
``` | ||
|
||
## Arguments Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `name` - (Required) The name of the Automation Runbook. | ||
|
||
* `automation_account_name` - (Required) The name of the Automation Account the runbook belongs to. | ||
|
||
* `resource_group_name` - (Required) The name of the Resource Group where the Automation exists. | ||
|
||
## Attributes Reference | ||
|
||
In addition to the Arguments listed above - the following Attributes are exported: | ||
|
||
* `id` - The Automation Runbook ID. | ||
|
||
* `content` - The content of the Runbook. | ||
|
||
* `description` - The description of the Runbook. | ||
|
||
* `location` - The Azure Region where the Runbook exists. | ||
|
||
* `log_activity_trace_level` - The activity-level tracing of the Runbook. | ||
|
||
* `log_progress` - The Progress log option of the Runbook. | ||
|
||
* `log_verbose` - The Verbose log option of the Runbook. | ||
|
||
* `runbook_type` - The type of Runbook. | ||
|
||
* `tags` - A mapping of tags assigned to the Runbook. | ||
|
||
## Timeouts | ||
|
||
The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions: | ||
|
||
* `read` - (Defaults to 5 minutes) Used when retrieving the Automation. |