feat(gateway): onboard new resource/data-source

.changes/unreleased/added-20250307-024333.yaml

@@ -0,0 +1,5 @@
+kind: added
+body: Onboard new resource/data-source `fabric_gateway`.
+time: 2025-03-07T02:43:33.229242334Z
+custom:
+  Issue: "170"

.gitignore

@@ -37,7 +37,6 @@ testresults.xml
 golangci-report.xml
 .wellknown.json
 .wellknown.*.json
-!.wellknown.template.json
 changie.md
 .lycheecache
 *.env

DEVELOPER.md

@@ -298,6 +298,8 @@ FABRIC_TESTACC_WELLKNOWN_AZURE_SUBSCRIPTION_ID="<AZURE SUBSCRIPTION ID>"
 FABRIC_TESTACC_WELLKNOWN_FABRIC_CAPACITY_NAME="<FABRIC CAPACITY NAME>"
 FABRIC_TESTACC_WELLKNOWN_AZDO_ORGANIZATION_NAME="<AZURE DEVOPS ORGANIZATION NAME>"
 FABRIC_TESTACC_WELLKNOWN_NAME_PREFIX="<RESOURCES PREFIX>"
+FABRIC_TESTACC_WELLKNOWN_AZURE_RESOURCE_GROUP_NAME="<AZURE RESOURCE GROUP NAME>"
+FABRIC_TESTACC_WELLKNOWN_AZURE_LOCATION"<AZURE LOCATION>"
 
 # Optional
 FABRIC_TESTACC_WELLKNOWN_NAME_SUFFIX=""

docs/data-sources/gateway.md

@@ -0,0 +1,67 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "fabric_gateway Data Source - terraform-provider-fabric"
+subcategory: ""
+description: |-
+  Get a Fabric Gateway.
+  Use this data source to get Gateway https://learn.microsoft.com/power-bi/guidance/powerbi-implementation-planning-data-gateways.
+  -> This item supports Service Principal authentication.
+---
+
+# fabric_gateway (Data Source)
+
+Get a Fabric Gateway.
+
+Use this data source to get [Gateway](https://learn.microsoft.com/power-bi/guidance/powerbi-implementation-planning-data-gateways).
+
+-> This item supports Service Principal authentication.
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `display_name` (String) The Gateway display name.
+- `id` (String) The Gateway ID.
+- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))
+
+### Read-Only
+
+- `allow_cloud_connection_refresh` (Boolean) Allow cloud connection refresh.
+- `allow_custom_connectors` (Boolean) Allow custom connectors.
+- `capacity_id` (String) The Gateway capacity ID.
+- `inactivity_minutes_before_sleep` (Number) The Gateway inactivity minutes before sleep. Possible values: `120`, `1440`, `150`, `240`, `30`, `360`, `480`, `60`, `720`, `90`
+- `load_balancing_setting` (String) The load balancing setting. Possible values: `DistributeEvenly`, `Failover`
+- `number_of_member_gateways` (Number) The number of member gateways. Possible values: 1 to 7.
+- `public_key` (Attributes) The public key of the primary gateway member. Used to encrypt the credentials for creating and updating connections. (see [below for nested schema](#nestedatt--public_key))
+- `type` (String) The Gateway type. Possible values: `OnPremises`, `OnPremisesPersonal`, `VirtualNetwork`
+- `version` (String) The Gateway version.
+- `virtual_network_azure_resource` (Attributes) The Azure virtual network resource. (see [below for nested schema](#nestedatt--virtual_network_azure_resource))
+
+<a id="nestedatt--timeouts"></a>
+
+### Nested Schema for `timeouts`
+
+Optional:
+
+- `read` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
+
+<a id="nestedatt--public_key"></a>
+
+### Nested Schema for `public_key`
+
+Read-Only:
+
+- `exponent` (String) The exponent.
+- `modulus` (String) The modulus.
+
+<a id="nestedatt--virtual_network_azure_resource"></a>
+
+### Nested Schema for `virtual_network_azure_resource`
+
+Read-Only:
+
+- `resource_group_name` (String) The resource group name.
+- `subnet_name` (String) The subnet name.
+- `subscription_id` (String) The subscription ID.
+- `virtual_network_name` (String) The virtual network name.

docs/data-sources/gateway_role_assignments.md

@@ -0,0 +1,50 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "fabric_gateway_role_assignments Data Source - terraform-provider-fabric"
+subcategory: ""
+description: |-
+  List Fabric Gateway Role Assignments.
+  Use this data source to list [Gateway Role Assignments].
+  -> This item supports Service Principal authentication.
+---
+
+# fabric_gateway_role_assignments (Data Source)
+
+List Fabric Gateway Role Assignments.
+
+Use this data source to list [Gateway Role Assignments].
+
+-> This item supports Service Principal authentication.
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `gateway_id` (String) The Gateway ID.
+
+### Optional
+
+- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))
+
+### Read-Only
+
+- `values` (Attributes List) The list of Gateway Role Assignments. (see [below for nested schema](#nestedatt--values))
+
+<a id="nestedatt--timeouts"></a>
+
+### Nested Schema for `timeouts`
+
+Optional:
+
+- `read` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
+
+<a id="nestedatt--values"></a>
+
+### Nested Schema for `values`
+
+Read-Only:
+
+- `id` (String) The Principal ID.
+- `role` (String) The gateway role of the principal. Possible values: `Admin`, `ConnectionCreator`, `ConnectionCreatorWithResharing`.
+- `type` (String) The type of the principal. Possible values: `Group`, `ServicePrincipal`, `ServicePrincipalProfile`, `User`.

docs/data-sources/gateways.md

@@ -0,0 +1,78 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "fabric_gateways Data Source - terraform-provider-fabric"
+subcategory: ""
+description: |-
+  List a Fabric Gateways.
+  Use this data source to list Gateways https://learn.microsoft.com/power-bi/guidance/powerbi-implementation-planning-data-gateways.
+  -> This item supports Service Principal authentication.
+---
+
+# fabric_gateways (Data Source)
+
+List a Fabric Gateways.
+
+Use this data source to list [Gateways](https://learn.microsoft.com/power-bi/guidance/powerbi-implementation-planning-data-gateways).
+
+-> This item supports Service Principal authentication.
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))
+
+### Read-Only
+
+- `values` (Attributes List) The list of Gateways. (see [below for nested schema](#nestedatt--values))
+
+<a id="nestedatt--timeouts"></a>
+
+### Nested Schema for `timeouts`
+
+Optional:
+
+- `read` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
+
+<a id="nestedatt--values"></a>
+
+### Nested Schema for `values`
+
+Optional:
+
+- `display_name` (String) The Gateway display name.
+- `id` (String) The Gateway ID.
+
+Read-Only:
+
+- `allow_cloud_connection_refresh` (Boolean) Allow cloud connection refresh.
+- `allow_custom_connectors` (Boolean) Allow custom connectors.
+- `capacity_id` (String) The Gateway capacity ID.
+- `inactivity_minutes_before_sleep` (Number) The Gateway inactivity minutes before sleep. Possible values: `120`, `1440`, `150`, `240`, `30`, `360`, `480`, `60`, `720`, `90`
+- `load_balancing_setting` (String) The load balancing setting. Possible values: `DistributeEvenly`, `Failover`
+- `number_of_member_gateways` (Number) The number of member gateways. Possible values: 1 to 7.
+- `public_key` (Attributes) The public key of the primary gateway member. Used to encrypt the credentials for creating and updating connections. (see [below for nested schema](#nestedatt--values--public_key))
+- `type` (String) The Gateway type. Possible values: `OnPremises`, `OnPremisesPersonal`, `VirtualNetwork`
+- `version` (String) The Gateway version.
+- `virtual_network_azure_resource` (Attributes) The Azure virtual network resource. (see [below for nested schema](#nestedatt--values--virtual_network_azure_resource))
+
+<a id="nestedatt--values--public_key"></a>
+
+### Nested Schema for `values.public_key`
+
+Read-Only:
+
+- `exponent` (String) The exponent.
+- `modulus` (String) The modulus.
+
+<a id="nestedatt--values--virtual_network_azure_resource"></a>
+
+### Nested Schema for `values.virtual_network_azure_resource`
+
+Read-Only:
+
+- `resource_group_name` (String) The resource group name.
+- `subnet_name` (String) The subnet name.
+- `subscription_id` (String) The subscription ID.
+- `virtual_network_name` (String) The virtual network name.

docs/data-sources/workspace_role_assignments.md

@@ -3,14 +3,14 @@
 page_title: "fabric_workspace_role_assignments Data Source - terraform-provider-fabric"
 subcategory: ""
 description: |-
-  List a Fabric Workspace Role Assignments.
+  List Fabric Workspace Role Assignments.
   Use this data source to list Workspace Role Assignments https://learn.microsoft.com/power-bi/collaborate-share/service-roles-new-workspaces.
   -> This item supports Service Principal authentication.
 ---
 
 # fabric_workspace_role_assignments (Data Source)
 
-List a Fabric Workspace Role Assignments.
+List Fabric Workspace Role Assignments.
 
 Use this data source to list [Workspace Role Assignments](https://learn.microsoft.com/power-bi/collaborate-share/service-roles-new-workspaces).
 

docs/resources/gateway.md

@@ -0,0 +1,59 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "fabric_gateway Resource - terraform-provider-fabric"
+subcategory: ""
+description: |-
+  This resource manages a Fabric Gateway.
+  See Gateways https://learn.microsoft.com/power-bi/guidance/powerbi-implementation-planning-data-gateways for more information.
+  -> This item supports Service Principal authentication.
+---
+
+# fabric_gateway (Resource)
+
+This resource manages a Fabric Gateway.
+
+See [Gateways](https://learn.microsoft.com/power-bi/guidance/powerbi-implementation-planning-data-gateways) for more information.
+
+-> This item supports Service Principal authentication.
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `type` (String) The Gateway type. Accepted values: `OnPremises`, `OnPremisesPersonal`, `VirtualNetwork`
+
+### Optional
+
+- `capacity_id` (String) The Gateway capacity ID.
+- `display_name` (String) The Gateway display name.
+- `inactivity_minutes_before_sleep` (Number) The Gateway inactivity minutes before sleep.
+- `number_of_member_gateways` (Number) The Gateway number of member gateways.
+- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))
+- `virtual_network_azure_resource` (Attributes) The Gateway virtual network Azure resource. (see [below for nested schema](#nestedatt--virtual_network_azure_resource))
+
+### Read-Only
+
+- `id` (String) The Gateway ID.
+
+<a id="nestedatt--timeouts"></a>
+
+### Nested Schema for `timeouts`
+
+Optional:
+
+- `create` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
+- `delete` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
+- `read` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
+- `update` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
+
+<a id="nestedatt--virtual_network_azure_resource"></a>
+
+### Nested Schema for `virtual_network_azure_resource`
+
+Required:
+
+- `resource_group_name` (String) The resource group name.
+- `subnet_name` (String) The subnet name.
+- `subscription_id` (String) The subscription ID.
+- `virtual_network_name` (String) The virtual network name.

docs/resources/gateway_role_assignment.md

@@ -0,0 +1,43 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "fabric_gateway_role_assignment Resource - terraform-provider-fabric"
+subcategory: ""
+description: |-
+  Manage a Gateway Role Assignment.
+  -> This item supports Service Principal authentication.
+---
+
+# fabric_gateway_role_assignment (Resource)
+
+Manage a Gateway Role Assignment.
+
+-> This item supports Service Principal authentication.
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `gateway_id` (String) The Gateway ID.
+- `principal_id` (String) The Principal ID.
+- `principal_type` (String) The type of the principal. Accepted values: `Group`, `ServicePrincipal`, `ServicePrincipalProfile`, `User`.
+- `role` (String) The Gateway Role of the principal. Accepted values: `Admin`, `ConnectionCreator`, `ConnectionCreatorWithResharing`.
+
+### Optional
+
+- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))
+
+### Read-Only
+
+- `id` (String) The Gateway Role Assignment ID.
+
+<a id="nestedatt--timeouts"></a>
+
+### Nested Schema for `timeouts`
+
+Optional:
+
+- `create` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
+- `delete` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
+- `read` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
+- `update` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

internal/provider/provider.go

@@ -45,6 +45,7 @@ import (
 	"github.com/microsoft/terraform-provider-fabric/internal/services/environment"
 	"github.com/microsoft/terraform-provider-fabric/internal/services/eventhouse"
 	"github.com/microsoft/terraform-provider-fabric/internal/services/eventstream"
+	"github.com/microsoft/terraform-provider-fabric/internal/services/gateway"
 	"github.com/microsoft/terraform-provider-fabric/internal/services/graphqlapi"
 	"github.com/microsoft/terraform-provider-fabric/internal/services/kqldashboard"
 	"github.com/microsoft/terraform-provider-fabric/internal/services/kqldatabase"
@@ -390,6 +391,8 @@ func (p *FabricProvider) Resources(ctx context.Context) []func() resource.Resour
 		func() resource.Resource { return environment.NewResourceEnvironment(ctx) },
 		func() resource.Resource { return eventhouse.NewResourceEventhouse(ctx) },
 		eventstream.NewResourceEventstream,
+		gateway.NewResourceGateway,
+		gateway.NewResourceGatewayRoleAssignment,
 		graphqlapi.NewResourceGraphQLApi,
 		kqldashboard.NewResourceKQLDashboard,
 		kqldatabase.NewResourceKQLDatabase,
@@ -430,6 +433,9 @@ func (p *FabricProvider) DataSources(ctx context.Context) []func() datasource.Da
 		func() datasource.DataSource { return eventhouse.NewDataSourceEventhouses(ctx) },
 		eventstream.NewDataSourceEventstream,
 		eventstream.NewDataSourceEventstreams,
+		gateway.NewDataSourceGateway,
+		gateway.NewDataSourceGateways,
+		gateway.NewDataSourceGatewayRoleAssignments,
 		graphqlapi.NewDataSourceGraphQLApi,
 		graphqlapi.NewDataSourceGraphQLApis,
 		kqldashboard.NewDataSourceKQLDashboard,

internal/services/gateway/base.go

@@ -0,0 +1,28 @@
+// Copyright (c) Microsoft Corporation
+// SPDX-License-Identifier: MPL-2.0
+
+package gateway
+
+import (
+	"github.com/microsoft/terraform-provider-fabric/internal/common"
+)
+
+const (
+	ItemName                     = "Gateway"
+	ItemTFName                   = "gateway"
+	ItemsName                    = "Gateways"
+	ItemsTFName                  = "gateways"
+	ItemDocsSPNSupport           = common.DocsSPNSupported
+	ItemDocsURL                  = "https://learn.microsoft.com/power-bi/guidance/powerbi-implementation-planning-data-gateways"
+	GatewayRoleAssignmentName    = "Gateway Role Assignment"
+	GatewayRoleAssignmentTFName  = "gateway_role_assignment"
+	GatewayRoleAssignmentsName   = "Gateway Role Assignments"
+	GatewayRoleAssignmentsTFName = "gateway_role_assignments"
+	ItemPreview                  = true
+)
+
+var (
+	PossibleInactivityMinutesBeforeSleepValues = []int32{30, 60, 90, 120, 150, 240, 360, 480, 720, 1440} //nolint:gochecknoglobals
+	MinNumberOfMemberGatewaysValues            = int32(1)                                                //nolint:gochecknoglobals
+	MaxNumberOfMemberGatewaysValues            = int32(7)                                                //nolint:gochecknoglobals
+)