@microsoft/terraform-cdk-constructs 0.0.3-pre.10

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,9 @@
+# Microsoft Open Source Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+
+Resources:
+
+- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
+- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns

package/CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# Contributing to the Terraform Azure CDK Modules
+
+Thank for your interesting in contributing! 
+
+- [Getting Started](#getting-started)
+- [Pull Requests](#pull-requests)
+  - [Step 1: Find something to work on](#step-1-find-something-to-work-on)
+  - [Step 2: Modifications](#step-2-modifications)
+  - [Step 3: Pull Request](#step-3-pull-request)
+  - [Step 4: Merge](#step-4-merge)
+- [Testing](#testing)
+  - [Unit Tests](#unit-tests)
+  - [Integration Tests](#integration-tests)
+
+## Getting Started
+
+To open this repository in a Code Space, click the button below:
+
+[![Open in Code Spaces](https://img.shields.io/badge/Open%20in%20Code%20Spaces-Terraform%20Azure%20CDK%20Modules%20Project-blue?logo=github)](https://github.com/microsoft/terraform-azure-cdk-modules/codespaces)
+
+## Pull Requests
+
+Pull requests are a key mechanism by which contributions are made to the project. They allow developers to propose changes, get feedback, and iterate on their ideas before merging them into the main project.
+
+### Step 1: Find something to work on
+
+You can start by looking at the project's open issues. Choose an issue that matches your expertise and interest. If you have a new feature or a bug fix that doesn't have an associated issue, you can create a new one.
+
+### Step 2: Modifications
+
+After identifying an issue, fork the repository to your GitHub account by clicking the 'Fork' button at the top right of the repository page. 
+
+Then, clone the forked repository to your local machine:
+
+```bash
+git clone https://github.com/<your-username>/terraform-azure-cdk-modules.git
+```
+
+Create a new branch for your task:
+
+```
+git checkout -b <branch-name>
+```
+
+Make your changes to the new branch. Be sure to adhere to the existing coding style, and include comments in your code as necessary.
+
+### Step 3: Pull Request
+Once you've made your changes, push them to your fork:
+```
+git add .
+git commit -m "<commit-message>"
+git push origin <branch-name>
+```
+
+Go to the GitHub page of your forked repository and click 'New pull request'. Choose the original repository as the base repository and your branch as the compare branch, then click 'Create pull request'.
+
+Fill out the pull request form. Include the issue number you're addressing, a summary of changes made, and any additional information that might be helpful for reviewers. Then, submit the pull request.
+
+### Step 4: Merge
+After your pull request has been reviewed and approved, a project maintainer will merge it into the main codebase. You will be notified once your changes have been merged.
+
+## Testing
+Testing is an essential part of the development process. We require both unit and integration tests for all modules.
+
+### Unit Tests
+To run the unit tests, use the following command:
+```
+npm test
+```
+
+### Integration Tests
+Integration tests allow us to deploy in an Azure environment and verify that the code will work and is idempotent. We use Terratest for our integration tests.
+
+Remember to create a test with all default values and additional tests for other potential configurations, within reason. Do not create a multitude of tests for a configuration that has many options.
+
+To run the integration test, use the following command in the module test directory:
+```
+go test -v resource_group_test.go
+```
+
+These tests will run in your own Azure subscription. They will look for the ARM_SUBSCRIPTION_ID environment variable, and if it's not available, it will try to pull from Azure CLI and use the current subscription context.
+
+Please be aware that running integration tests may incur charges on your Azure account. Always verify the resources you are creating and their associated costs.
+
+**Thank you for your interest in contributing to the Azure Terraform CDK Modules project! Your efforts help make our project even better.**

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2024 Microsoft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,152 @@
+# Azure Terraform CDK Constructs
+Welcome to the Azure Terraform CDK Constructs project! This library offers a comprehensive suite of L2 Constructs designed to simplify and enhance the experience of building and managing Azure infrastructure with the Cloud Development Kit for Terraform (CDKTF).
+
+## Benefits of Using L2 Constructs
+
+With L2 Constructs, you get the following benefits:
+
+- **Abstraction**: Higher-level abstractions over Azure resources make your infrastructure code more declarative and easier to understand.
+- **Reusability**: Encapsulate common patterns and best practices in your infrastructure code, promoting reusability across different projects and teams.
+- **Rapid Development**: Accelerate your cloud development process with pre-built constructs that have been tested for common use cases, allowing you to focus on your unique application logic.
+- **Direct IDE Integration**: Access detailed documentation directly within your Integrated Development Environment (IDE), streamlining your development workflow: ![alt text](./docs/images/ide-documentation.png)
+
+
+## Quick Example
+
+This is a quick example that showcases the simplicity and power of L2 Constructs. We'll create a storage account, add a container to it, and then upload a blob—all with a few lines of intuitive, object-oriented code:
+
+```typescript
+
+// Create a new instance of a storage account as an object
+const sa = new azcdk.azure_storageaccount.Account(stack, "storageaccount", {
+  name: "testStorageAccount",
+  location: "eastus",
+});
+
+// Add a container to the storage account by calling a method on the storage account object
+const container = sa.addContainer("testcontainer");
+
+// Add a blob to the container by calling a method on the container object
+// The path "../../../test.txt" points to the source file to be uploaded as a blob
+container.addBlob("testblob.txt", "../../../test.txt");
+```
+
+
+
+## Getting Started
+
+This guide will walk you through the process of using the Azure L2 Constructs to define and provision infrastructure on Azure. 
+
+### Prerequisites
+Make sure you have Node.js and npm installed on your machine. These will be used to install the CDK for Terraform and Azure provider packages.
+
+### Installation
+
+First, install the CDK for Terraform CLI globally using npm:
+
+```sh
+npm install -g cdktf-cli
+```
+
+Next, initialize a new CDK for Terraform project with TypeScript template:
+```sh
+cdktf init --template="TypeScript" --local
+```
+Install the AzureRM provider for CDKTF:
+
+```sh
+npm install @cdktf/provider-azurerm
+```
+
+Then, add the Microsoft Terraform CDK constructs for Azure:
+
+```sh
+npm install @micrsoft/terraform-cdk-constructs
+
+```
+
+
+### Example 1: Creating a Storage Account
+Now let's create a simple Azure storage account. The following TypeScript snippet defines a storage account resource using the CDKTF:
+
+```typescript
+// Import necessary modules and classes
+import * as azcdk from "@microsoft/terraform-cdk-constructs";
+import { Construct } from 'constructs';
+import { App, TerraformStack } from 'cdktf';
+import { AzurermProvider } from "@cdktf/provider-azurerm/lib/provider";
+
+// Define a new Terraform stack
+class AzureAppInfra extends TerraformStack {
+ constructor(scope: Construct, name: string) {
+   super(scope, name);
+
+   // Initialize Azure provider
+   new AzurermProvider(this, "azureFeature", { features: {} });
+
+   // Create a new Azure storage account with the specified name and location
+   new azcdk.azure_storageaccount.Account(this, "storageaccount", {
+     name: "test42348808",
+     location: "eastus",
+   });
+ }
+}
+
+// Initialize the CDK app and synthesize Terraform configurations
+const app = new App();
+new AzureAppInfra(app, 'cdk');
+app.synth();
+```
+After defining your infrastructure, generate the Terraform configuration files:
+```sh
+cdktf synth
+```
+Finally, deploy your infrastructure to Azure:
+
+```sh
+cdktf deploy
+```
+## Supported Languages
+
+Currently, our CDK L2 constructs are available in the following languages:
+
+| Language   | Status       |
+|------------|--------------|
+| TypeScript | Available    |
+| Python     | Coming soon  |
+| Java       | Coming soon  |
+| Go         | Coming soon  |
+| C#         | Coming soon  |
+
+Stay tuned for updates as we work to expand support to other popular programming languages!
+
+
+## Contributing
+
+This project welcomes contributions and suggestions.  Most contributions require you to agree to a
+Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
+the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+
+When you submit a pull request, a CLA bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
+provided by the bot. You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+We welcome contributions to this project! See our documentation on [how to get started contributing](./docs/CONTRIBUTING.md). 
+
+## Code Spaces
+
+To open this repository in a Code Space, click the button below:
+
+[![Open in Code Spaces](https://img.shields.io/badge/Open%20in%20Code%20Spaces-Terraform%20Azure%20CDK%20Modules%20Project-blue?logo=github)](https://github.com/microsoft/terraform-azure-cdk-modules/codespaces)
+
+## Trademarks
+
+This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
+trademarks or logos is subject to and must follow 
+[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+Any use of third-party trademarks or logos are subject to those third-party's policies.

package/SECURITY.md

@@ -0,0 +1,41 @@
+<!-- BEGIN MICROSOFT SECURITY.MD V0.0.8 BLOCK -->
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
+
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition), please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report).
+
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc). 
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+  * Full paths of source file(s) related to the manifestation of the issue
+  * The location of the affected source code (tag/branch/commit or direct URL)
+  * Any special configuration required to reproduce the issue
+  * Step-by-step instructions to reproduce the issue
+  * Proof-of-concept or exploit code (if possible)
+  * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) page for more details about our active programs.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Policy
+
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd).
+
+<!-- END MICROSOFT SECURITY.MD BLOCK -->

package/SUPPORT.md

@@ -0,0 +1,25 @@
+# TODO: The maintainer of this repo has not yet edited this file
+
+**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?
+
+- **No CSS support:** Fill out this template with information about how to file issues and get help.
+- **Yes CSS support:** Fill out an intake form at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). CSS will work with/help you to determine next steps.
+- **Not sure?** Fill out an intake as though the answer were "Yes". CSS will help you decide.
+
+*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*
+
+# Support
+
+## How to file issues and get help  
+
+This project uses GitHub Issues to track bugs and feature requests. Please search the existing 
+issues before filing new issues to avoid duplicates.  For new issues, file your bug or 
+feature request as a new Issue.
+
+For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE 
+FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
+CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
+
+## Microsoft Support Policy  
+
+Support for this **PROJECT or PRODUCT** is limited to the resources listed above.

package/cdktf.json

@@ -0,0 +1,11 @@
+{
+  "language": "typescript",
+  "app": "npx ts-node ./src/examples/AzureResourceGroup.ts",
+  "terraformProviders": ["Azure/azapi@~> 0.6.0","random@~> 3.5.1"],
+  "projectId": "1b5f16bd-67ac-4af6-a33f-7bcafff141eb",
+  "context": {
+    "excludeStackIdFromLogicalIds": "true",
+    "allowSepCharsInLogicalIds": "true",
+    "overrideLogicalId": "true"
+  }
+}

package/cdktf.out/manifest.json

@@ -0,0 +1,13 @@
+{
+  "version": "0.17.3",
+  "stacks": {
+    "testExampleAzureResource": {
+      "name": "testExampleAzureResource",
+      "constructPath": "testExampleAzureResource",
+      "workingDirectory": "stacks/testExampleAzureResource",
+      "synthesizedStackPath": "stacks/testExampleAzureResource/cdk.tf.json",
+      "annotations": [],
+      "dependencies": []
+    }
+  }
+}

package/cdktf.out/stacks/testAzureActionGroup/cdk.tf.json

@@ -0,0 +1,111 @@
+{
+  "//": {
+    "metadata": {
+      "backend": "local",
+      "stackName": "testAzureActionGroup",
+      "version": "0.17.3"
+    },
+    "outputs": {
+      "testAzureActionGroup": {
+        "id": "id",
+        "testAzureActionGroup": {
+          "id": "id"
+        }
+      }
+    }
+  },
+  "output": {
+    "id": {
+      "value": "${azurerm_monitor_action_group.testAzureActionGroup_actiongroup_73C559FB.id}"
+    }
+  },
+  "provider": {
+    "azurerm": [
+      {
+        "features": {
+          "resource_group": {
+            "prevent_deletion_if_contains_resources": false
+          }
+        }
+      }
+    ]
+  },
+  "resource": {
+    "azurerm_monitor_action_group": {
+      "testAzureActionGroup_actiongroup_73C559FB": {
+        "//": {
+          "metadata": {
+            "path": "testAzureActionGroup/testAzureActionGroup/actiongroup",
+            "uniqueId": "testAzureActionGroup_actiongroup_73C559FB"
+          }
+        },
+        "email_receiver": [
+          {
+            "email_address": "test1@email.com",
+            "name": "testemail1",
+            "use_common_alert_schema": true
+          },
+          {
+            "email_address": "test2@email.com",
+            "name": "testemail2",
+            "use_common_alert_schema": false
+          }
+        ],
+        "enabled": true,
+        "location": "global",
+        "name": "testactiongroup",
+        "resource_group_name": "${azurerm_resource_group.rg.name}",
+        "short_name": "testshortn",
+        "tags": {
+        },
+        "webhook_receiver": [
+          {
+            "name": "testwebhook1",
+            "service_uri": "https://www.example1.com",
+            "use_common_alert_schema": true
+          },
+          {
+            "name": "testwebhook2",
+            "service_uri": "https://www.example2.com",
+            "use_common_alert_schema": false
+          }
+        ]
+      }
+    },
+    "azurerm_resource_group": {
+      "rg": {
+        "//": {
+          "metadata": {
+            "path": "testAzureActionGroup/rg",
+            "uniqueId": "rg"
+          }
+        },
+        "location": "eastus",
+        "name": "rg-${var.name}",
+        "tags": {
+          "test": "test"
+        }
+      }
+    }
+  },
+  "terraform": {
+    "backend": {
+      "local": {
+        "path": "/home/runner/work/terraform-cdk-constructs/terraform-cdk-constructs/terraform.testAzureActionGroup.tfstate"
+      }
+    },
+    "required_providers": {
+      "azurerm": {
+        "source": "azurerm",
+        "version": "3.70.0"
+      }
+    }
+  },
+  "variable": {
+    "name": {
+      "default": "test",
+      "description": "System name used to randomize the resources",
+      "type": "string"
+    }
+  }
+}