### Create agent pool and install agent using helm chart

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/agent_pool.md

This example demonstrates how to create a basic agent pool and then use the `helm_release` resource to install the env0 agent using its Helm chart. It highlights the use of `env0_agent_secret` to securely pass the agent access token.

```terraform
variable "agent_custom_configuration" {
  type        = map(any)
  description = "See https://docs.envzero.com/guides/admin-guide/self-hosted-kubernetes-agent/custom-optional-configuration"
}

resource "env0_agent_pool" "default" {
  name = "default self-hosted agent"
}

resource "env0_agent_secret" "first" {
  agent_id = env0_agent_pool.default.id
}

resource "helm_release" "this" {
  repository = "https://env0.github.io/self-hosted"
  chart      = "env0-agent"

  namespace = "env0-agent-default"
  name      = "env0-agent-default"

  create_namespace = true
  timeout          = 600

  set_sensitive {
    name  = "agentAccessToken"
    value = env0_agent_secret.first.secret
  }

  values = [
    yamlencode(var.agent_custom_configuration)
  ]
}
```

--------------------------------

### Install Mockgen

Source: https://github.com/env0/terraform-provider-env0/blob/main/README.md

Install the mockgen tool from Uber's Go libraries, which is used for generating mock implementations of interfaces.

```shell
go install go.uber.org/mock/mockgen@v0.5.0
```

--------------------------------

### Example Usage of env0 Templates Data Source

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/templates.md

This example demonstrates how to fetch all template names using the `env0_templates` data source and then retrieve individual template details using the `env0_template` data source for each name. It also shows how to output the names of the fetched templates.

```terraform
data "env0_templates" "all_templates" {}

data "env0_template" "templates" {
  for_each = toset(data.env0_templates.all_templates.names)
  name     = each.value
}

output "template1_name" {
  value = data.env0_template.templates["Github Test-111"].name
}

output "template2_name" {
  value = data.env0_template.templates["Github Test-222"].name
}
```

--------------------------------

### Install Pre-commit Hooks

Source: https://github.com/env0/terraform-provider-env0/blob/main/README.md

Commands to install pre-commit and pre-push hooks for maintaining code style and quality during development.

```bash
pre-commit install
pre-commit install --hook-type pre-push
```

--------------------------------

### env0_github_installation_id Data Source

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/github_installation_id.md

Example of how to use the env0_github_installation_id data source to retrieve the GitHub installation ID for a repository.

```APIDOC
## env0_github_installation_id Data Source

### Description
Returns the GitHub installation ID of a GitHub repository.

### Method
GET (Implicitly through Terraform data source)

### Endpoint
N/A (Terraform data source)

### Parameters
#### Query Parameters
- **repository** (String) - Required - The URL of the GitHub repository (e.g., "https://github.com/env0/templates").

### Request Example
```terraform
data "env0_github_installation_id" "example" {
  repository = "https://github.com/env0/templates"
}

output "github_installation_id" {
  value = data.env0_github_installation_id.example.github_installation_id
}
```

### Response
#### Success Response (200)
- **github_installation_id** (Number) - The GitHub installation ID.
- **id** (String) - The ID of this resource.

#### Response Example
```json
{
  "github_installation_id": 123456,
  "id": "example"
}
```
```

--------------------------------

### Basic env0_environment Resource

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/environment.md

This example shows how to create a basic environment resource. It requires data sources for the template and project.

```terraform
data "env0_template" "example" {
  name = "Template Name"
}

data "env0_project" "default_project" {
  name = "Default Organization Project"
}

resource "env0_environment" "example" {
  name        = "environment"
  project_id  = data.env0_project.default_project.id
  template_id = data.env0_template.example.id
}
```

--------------------------------

### env0_git_token Resource and Data Sources

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/git_token.md

This example demonstrates how to create a git token resource and then reference it using data sources by ID and by name.

```terraform
resource "env0_git_token" "git_token_sample" {
  name  = "name"
  value = "value"
}

data "env0_git_token" "git_token_sample_by_id" {
  id = env0_git_token.git_token_sample.id
}

data "env0_git_token" "git_token_sample_by_name" {
  name = env0_git_token.git_token_sample.name
}
```

--------------------------------

### Import env0_api_key by Name

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/api_key.md

This example demonstrates importing an existing env0 API key using its name. This method is an alternative to importing by ID for managing existing resources.

```shell
terraform import env0_api_key.by_name api-key-name
```

--------------------------------

### env0_oci_credentials Resource

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/oci_credentials.md

Example usage of the env0_oci_credentials resource to configure OCI credentials.

```APIDOC
## env0_oci_credentials (Resource)

### Description

Manages OCI credentials within env0.

### Method

Not applicable (Terraform resource)

### Endpoint

Not applicable (Terraform resource)

### Parameters

#### Path Parameters

None

#### Query Parameters

None

#### Request Body

- **name** (String) - Required - name for the oci credentials
- **tenancy_ocid** (String) - Required - OCI tenancy OCID
- **user_ocid** (String) - Required - OCI user OCID
- **fingerprint** (String) - Required - OCI API key fingerprint
- **private_key** (String, Sensitive) - Required - OCI API private key
- **region** (String) - Required - OCI region
- **project_id** (String) - Optional - the env0 project id to associate the credentials with

### Request Example

```terraform
resource "env0_oci_credentials" "example" {
  name         = "my-oci-credentials"
  tenancy_ocid = "ocid1.tenancy.oc1..exampleuniqueID"
  user_ocid    = "ocid1.user.oc1..exampleuniqueID"
  fingerprint  = "12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef"
  private_key  = <<EOF
-----BEGIN PRIVATE KEY-----
MIIEvQIBADANBgkqhkiG9w0BAQEFAASC...
-----END PRIVATE KEY-----
EOF
  region       = "us-phoenix-1"
}
```

### Response

#### Success Response (200)

- **id** (String) - The ID of this resource.

#### Response Example

```json
{
  "id": "some-unique-id"
}
```
```

--------------------------------

### env0_git_token Resource Example

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/git_token.md

Use this resource to manage git tokens within env0. Ensure the name and value are provided.

```terraform
resource "env0_git_token" "git_token_sample" {
  name  = "sample-name"
  value = "sample-value"
}
```

--------------------------------

### Example Usage of env0_aws_eks_credentials

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/aws_eks_credentials.md

Demonstrates how to define an env0 AWS EKS credentials resource and assign it to a project. Ensure the env0_project data source is configured correctly.

```terraform
resource "env0_aws_eks_credentials" "credentials" {
  name           = "example"
  cluster_name   = "my-cluster"
  cluster_region = "us-east-2"
}

data "env0_project" "project" {
  name = "my-project"
}

resource "env0_cloud_credentials_project_assignment" "assignment" {
  credential_id = env0_aws_eks_credentials.credentials.id
  project_id    = data.env0_project.project.id
}
```

--------------------------------

### env0_project_policy Resource

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/project_policy.md

Example usage of the env0_project_policy resource to configure project policies.

```APIDOC
## env0_project_policy (Resource)

### Description
Manages project-level policies within env0.

### Method
Not Applicable (Terraform Resource)

### Endpoint
Not Applicable (Terraform Resource)

### Parameters
#### Required
- **project_id** (String) - id of the project

#### Optional
- **auto_drift_remediation** (String) - Auto drift remediation strategy (DISABLED, CODE_TO_CLOUD, CLOUD_TO_CODE, SMART_REMEDIATION). Defaults to DISABLED
- **continuous_deployment_default** (Boolean) - Redeploy on every push to the git branch default value
- **default_ttl** (String) - the default environment time-to-live allowed on deploy time. Format is <number>-<M/w/d/h> (Examples: 12-h, 3-d, 1-w, 1-M). Default value is 'inherit' which inherits the organization policy. must be equal or shorter than max_ttl
- **disable_destroy_environments** (Boolean) - Disallow destroying environment in the project
- **drift_detection_cron** (String) - default cron expression for new environments
- **force_remote_backend** (Boolean) - if 'true' all environments created in this project will be forced to use env0 remote backend. Default is 'false'
- **include_cost_estimation** (Boolean) - Enable cost estimation for the project
- **max_ttl** (String) - the maximum environment time-to-live allowed on deploy time. Format is <number>-<M/w/d/h> (Examples: 12-h, 3-d, 1-w, 1-M). Default value is 'inherit' which inherits the organization policy. must be equal or longer than default_ttl
- **number_of_environments** (Number) - Max number of environments a single user can have in this project. Omitting removes the restriction.
- **number_of_environments_total** (Number) - Max number of environments in this project. Omitting removes the restriction.
- **outputs_as_inputs_enabled** (Boolean) - if 'true' enables 'environment outputs'. Default is 'false'
- **requires_approval_default** (Boolean) - Requires approval default value when creating a new environment in the project
- **run_pull_request_plan_default** (Boolean) - Run Terraform Plan on Pull Requests for new environments targeting their branch default value
- **skip_apply_when_plan_is_empty** (Boolean) - Skip apply when plan has no changes
- **skip_redundant_deployments** (Boolean) - Automatically skip queued deployments when a newer deployment is triggered
- **vcs_pr_comments_enabled_default** (Boolean) - if 'true' all environments created in this project will be created with an 'enabled' running VCS PR plan/apply commands using PR comments. Default is 'false'

### Read-Only Properties
- **id** (String) - id of the policy
- **updated_by** (String) - updated by

### Example Usage
```terraform
data "env0_project" "default_project" {
  name = "Default Organization Project"
}

resource "env0_project_policy" "example" {
  project_id                    = data.env0_project.default_project.id
  number_of_environments        = 1
  number_of_environments_total  = 1
  requires_approval_default     = true
  include_cost_estimation       = true
  skip_apply_when_plan_is_empty = true
  disable_destroy_environments  = true
  skip_redundant_deployments    = true
  drift_detection_cron          = "0 4 * * *"     # Run drift detection daily at 4 AM
  auto_drift_remediation        = "CODE_TO_CLOUD" # Optional, defaults to "DISABLED"
}
```
```

--------------------------------

### Retrieve Self-hosted VCS Connection (GitHub Enterprise Example)

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/vcs_connection.md

Use this snippet to fetch a self-hosted VCS connection, such as GitHub Enterprise. The `access_scope` should start with 'url:' followed by the base URL or repository URL.

```terraform
data "env0_vcs_connection" "github_enterprise" {
  access_scope    = "url:https://github.mycompany.com"
  connection_type = "DeploymentPipeline"
}
```

--------------------------------

### env0_gcp_cloud_configuration Example

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/gcp_cloud_configuration.md

Use this resource to configure a GCP cloud account. Ensure the credential configuration file content is provided.

```terraform
resource "env0_gcp_cloud_configuration" "example" {
  name                                  = "example-gcp-config"
  gcp_project_id                        = "your-gcp-project-id"
  credential_configuration_file_content = file("path/to/your-gcp-service-account.json")
}
```

--------------------------------

### Create Azure Cost Credentials and Assign to Project

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/cost_credentials_project_assignment.md

This example demonstrates how to create Azure cost credentials and then assign them to a project. Ensure you have the necessary Azure credentials configured.

```terraform
resource "env0_azure_cost_credentials" "azure_cost_credentials" {
  name            = "cost credentials"
  client_id       = "client id"
  client_secret   = "client secret"
  subscription_id = "43242342dsdfsdfsdf"
  tenant_id       = "fsdf-fsdfdsfs-fsdfsdfsd-fsdfsd"
}

resource "env0_project" "project" {
  name = "project"
}

resource "env0_cost_credentials_project_assignment" "cost_project_assignment" {
  credential_id = env0_azure_cost_credentials.azure_cost_credentials.id
  project_id    = env0_project.project.id
}
```

--------------------------------

### env0_environment Resource with HCL Configuration

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/environment.md

This example demonstrates creating an environment with a specific HCL configuration. Ensure the configuration name and type are set correctly.

```terraform
resource "env0_environment" "example_with_hcl_configuration" {
  name        = "environment with hcl"
  project_id  = data.env0_project.default_project.id
  template_id = data.env0_template.example.id

  configuration {
    name          = "TEST1234"
    type          = "terraform"
    value         = <<EOF
      {
        a = "world11111"
        b = {
          c = "d"
        }
      }
    EOF
    schema_format = "HCL"
  }
}
```

--------------------------------

### Create an Admin API Key

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/api_key.md

This example demonstrates creating a default admin API key. No specific roles or permissions are assigned, granting full administrative access.

```terraform
resource "env0_api_key" "admin_key" {
  name = "admin-api-key"
}
```

--------------------------------

### Basic env0 Template Configuration

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/template.md

This example shows how to define a basic env0 template using a Git repository and a specific path. It includes fetching project and SSH key data for configuration.

```terraform
data "env0_project" "default_project" {
  name = "Default Organization Project"
}

data "env0_ssh_key" "my_key" {
  name = "Secret Key"
}

resource "env0_template" "example" {
  name        = "example"
  description = "Example template"
  repository  = "https://github.com/env0/templates"
  path        = "aws/hello-world"
  ssh_keys    = [data.env0_ssh_key.my_key]
}
```

--------------------------------

### Template with GitHub Installation ID

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/template.md

This snippet demonstrates configuring a template with a GitHub installation ID, useful for private repositories. It specifies the repository and a custom Terraform version.

```terraform
resource "env0_template" "example_github_installation_id" {
  name                   = "example"
  description            = "Example template"
  repository             = "https://github.com/env0/templates"
  terraform_version      = "1.1.9"
  github_installation_id = 12223344
}
```

--------------------------------

### env0_api_key Data Source Example Usage

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/api_key.md

Demonstrates how to use the env0_api_key data source to retrieve API key information by ID or name.

```terraform
resource "env0_api_key" "api_key_sample" {
  name = "name"
}

data "env0_api_key" "api_key_sample_by_id" {
  id = env0_api_key.api_key_sample.id
}

data "env0_api_key" "api_key_sample_by_name" {
  name = env0_api_key.api_key_sample.name
}
```

--------------------------------

### env0_configuration_variable Data Source

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/configuration_variable.md

Example of how to use the env0_configuration_variable data source to retrieve a configuration variable and output its value.

```APIDOC
## env0_configuration_variable Data Source

### Description

This data source retrieves details about a specific configuration variable within env0.

### Method

DATA SOURCE

### Endpoint

N/A (Data Source)

### Parameters

#### Optional

- **deployment_log_id** (String) - Optional - Search for the variable under this deployment log, not globally.
- **description** (String) - Optional - A description of the variable.
- **environment_id** (String) - Optional - Search for the variable under this environment, not globally.
- **id** (String) - Optional - ID of the configuration variable.
- **is_read_only** (Boolean) - Optional - Specifies if the value of this variable cannot be edited by lower scopes.
- **is_required** (Boolean) - Optional - Specifies if the value of this variable must be set by lower scopes.
- **name** (String) - Optional - The name of the configuration variable.
- **project_id** (String) - Optional - Search for the variable under this project, not globally.
- **regex** (String) - Optional - Specifies a regular expression to validate variable value (enforced only in env0 UI).
- **sub_environment_alias** (String) - Optional - Search for the variable for sub templates of a workflow. Requires template_id as well.
- **template_id** (String) - Optional - Search for the variable under this template, not globally.
- **type** (String) - Optional - 'terraform' or 'environment'. If specified as an argument, limits searching by variable name only to variables of this type.

### Read-Only Attributes

- **enum** (List of String) - Possible values of this variable.
- **format** (String) - Specifies the format of the configuration value (HCL/JSON).
- **is_sensitive** (Boolean) - Is the variable defined as sensitive.
- **scope** (String) - Scope of the variable.
- **value** (String, Sensitive) - Value stored in the variable.

### Request Example

```terraform
data "env0_configuration_variable" "aws_default_region" {
  name = "AWS_DEFAULT_REGION"
}

output "aws_default_region" {
  value = data.env0_configuration_variable.aws_default_region.value
}
```

### Response

#### Success Response (200)

- **value** (String, Sensitive) - The value of the configuration variable.
- **enum** (List of String) - Possible values of this variable.
- **format** (String) - Specifies the format of the configuration value (HCL/JSON).
- **is_sensitive** (Boolean) - Is the variable defined as sensitive.
- **scope** (String) - Scope of the variable.

#### Response Example

(Response body structure mirrors the schema, with values populated for the requested variable.)
```

--------------------------------

### Create env0 GPG Key Resource

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/gpg_key.md

Example of how to create a GPG key resource in env0 using Terraform. Ensure the key_id and content are valid.

```terraform
resource "env0_gpg_key" "example" {
  name    = "gpg-key-example"
  key_id  = "ABCDABCDABCDABCD"
  content = "key block"
}
```

--------------------------------

### Assign Notification to Project

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/notification_project_assignment.md

This example shows how to create a notification, a project, and then assign the notification to the project for the 'environmentMarkedForAutoDestroy' event.

```terraform
resource "env0_notification" "notification" {
  name  = "notification"
  type  = "Slack"
  value = "https://someurl.com"
}

resource "env0_project" "project" {
  name = "project"
}

resource "env0_notification_project_assignment" "notification_project_assignment" {
  project_id               = env0_project.project.id
  notification_endpoint_id = env0_notification.notification.id
  event_names              = ["environmentMarkedForAutoDestroy"]
}
```

--------------------------------

### env0_environment Data Source

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/environment.md

Example usage of the env0_environment data source to retrieve environment details by name or ID.

```APIDOC
## env0_environment (Data Source)

### Description

This data source allows you to retrieve details about an existing env0 environment.

### Method

GET

### Endpoint

`/api/v1/environments/{environment_id}` (Conceptual - actual retrieval is via Terraform provider)

### Parameters

#### Query Parameters

- **name** (String) - Optional - The name of the environment to retrieve.
- **id** (String) - Optional - The ID of the environment to retrieve.
- **exclude_archived** (Boolean) - Optional - Set to 'true' to exclude archived environments when getting an environment by name.
- **project_id** (String) - Optional - The project ID of the environment. Required if searching by name and multiple environments share the same name.

### Request Example

```terraform
data "env0_environment" "by_name" {
  name = "best-env"
}

data "env0_environment" "by_id" {
  id = "some_id"
}
```

### Response

#### Success Response (200)

- **id** (String) - The environment's ID.
- **name** (String) - The name of the environment.
- **project_id** (String) - The project ID of the environment.
- **approve_plan_automatically** (Boolean) - The default require approval of the environment.
- **auto_deploy_on_path_changes_only** (Boolean) - Continuous deployment on file changes in path is enabled.
- **bitbucket_client_key** (String) - Bitbucket client key.
- **deploy_on_push** (Boolean) - Continuous deployment is enabled.
- **deployment_id** (String) - The ID of the latest deployment.
- **github_installation_id** (Number) - GitHub installation ID.
- **output** (String) - The deployment log output. Returns a JSON string. It can be either a map of key-value, or an array of (in case of Terragrunt run-all) of moduleName and a map of key-value. Note: if the deployment is still in progress returns 'null'.
- **revision** (String) - The last deployed revision.
- **run_plan_on_pull_requests** (Boolean) - PR plan is enabled.
- **status** (String) - The status of the environment.
- **sub_environment_configuration** (List of Object) - The sub-environments of the workflow environment. (Empty for non-workflow environments).
  - **alias** (String) - Alias of the sub-environment.
  - **id** (String) - ID of the sub-environment.
- **template_id** (String) - The template ID the environment is to be created from.
- **token_id** (String) - The token ID used for repo integrations (Used by GitLab or Azure DevOps).

#### Response Example

```json
{
  "id": "some_id",
  "name": "best-env",
  "project_id": "some_project_id",
  "approve_plan_automatically": false,
  "auto_deploy_on_path_changes_only": false,
  "bitbucket_client_key": null,
  "deploy_on_push": true,
  "deployment_id": "some_deployment_id",
  "github_installation_id": null,
  "output": "{\"key\": \"value\"}",
  "revision": "some_revision",
  "run_plan_on_pull_requests": false,
  "status": "success",
  "sub_environment_configuration": [],
  "template_id": "some_template_id",
  "token_id": null
}
```
```

--------------------------------

### Create a User API Key with Project Permissions

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/api_key.md

This example shows how to create a user API key with specific project-level permissions. The API key is assigned the 'Deployer' role within a designated project.

```terraform
resource "env0_project" "project" {
  name = "demo-project"
}

resource "env0_api_key" "user_key_with_project" {
  name              = "user-api-key-project"
  organization_role = "User"

  project_permissions {
    project_id   = env0_project.project.id
    project_role = "Deployer"
  }
}
```

--------------------------------

### env0_ssh_key Data Source Example

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/ssh_key.md

Use the env0_ssh_key data source to fetch an existing SSH key by name and reference it in an env0_template resource.

```terraform
data "env0_ssh_key" "my_key" {
  name = "Secret Key"
}

resource "env0_template" "example" {
  # ...
  ssh_keys = [data.env0_ssh_key.my_key]
}
```

--------------------------------

### env0_module Data Source Example

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/module.md

Use the env0_module data source to retrieve details about a specific module by its name.

```terraform
data "env0_module" "some_name" {
  module_name = "module123"
}
```

--------------------------------

### Import env0_api_key by ID

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/api_key.md

This example shows how to import an existing env0 API key using its unique ID. This is useful for managing pre-existing resources within Terraform.

```shell
terraform import env0_api_key.by_id ddda7b30-6789-4d24-937c-22322754934e
```

--------------------------------

### env0_template Data Source Example

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/template.md

Use this data source to retrieve information about an env0 template by its name. Ensure the template name is accurate.

```terraform
data "env0_template" "example" {
  name = "Template Name"
}
```

--------------------------------

### Fetch all teams and access individual team data

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/teams.md

This example demonstrates how to fetch all team names using the `env0_teams` data source and then iterate over them to retrieve individual team details using the `env0_team` data source. It then outputs the names of specific teams.

```terraform
data "env0_teams" "all_teams" {}

data "env0_team" "teams" {
  for_each = toset(data.env0_teams.all_teams.names)
  name     = each.value
}

output "team1_name" {
  value = data.env0_team.teams["team1"].name
}

output "team2_name" {
  value = data.env0_team.teams["team2"].name
}
```

--------------------------------

### Terragrunt Template Configuration

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/template.md

This example configures a template specifically for Terragrunt, including the Terragrunt version and type. It also specifies the repository path and associated SSH keys.

```terraform
resource "env0_template" "example_terragrunt" {
  name               = "example - Terragrunt"
  description        = "Example template with Terragrunt version"
  repository         = "https://github.com/env0/templates"
  path               = "terragrunt/misc/null-resource"
  ssh_keys           = [data.env0_ssh_key.my_key]
  type               = "terragrunt"
  terragrunt_version = "0.35.0"
}
```

--------------------------------

### Assign User to Project with Custom Role

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/user_project_assignment.md

This example demonstrates assigning a user to a project using a custom role. First, define the custom role with its permissions, then create the assignment.

```terraform
resource "env0_custom_role" "custom_role_example" {
  name = "my custom role 1"
  permissions = [
    "VIEW_PROJECT",
    "EDIT_PROJECT_SETTINGS"
  ]
}

resource "env0_user_project_assignment" "role_assignment_custom_role_example" {
  user_id        = data.env0_user.user_example.id
  project_id     = env0_project.project_example.id
  custom_role_id = env0_custom_role.custom_role_example.id
}
```

--------------------------------

### Create an API Key with a Custom Role

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/api_key.md

This example demonstrates creating an API key assigned a custom role. It defines a custom role with specific permissions and then assigns this role to the API key for a particular project.

```terraform
resource "env0_custom_role" "deployer_role" {
  name = "custom-deployer"
  permissions = [
    "VIEW_ORGANIZATION",
    "VIEW_PROJECT",
    "VIEW_ENVIRONMENT",
    "RUN_PLAN",
    "RUN_APPLY"
  ]
}

resource "env0_api_key" "custom_role_key" {
  name              = "custom-role-api-key"
  organization_role = env0_custom_role.deployer_role.id

  project_permissions {
    project_id   = env0_project.project.id
    project_role = "Deployer"
  }
}
```

--------------------------------

### env0_gpg_key Data Source Example

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/gpg_key.md

Use the env0_gpg_key data source to retrieve a GPG key by its name or ID. Ensure the GPG key exists in your env0 environment.

```terraform
data "env0_gpg_key" "gpg_key_by_name" {
  name = "gpg key fegsdfg"
}

data "env0_gpg_key" "gpg_key_by_id" {
  id = "sdfsdxcvxc-sdfsd-fsdfsd-dsda"
}
```

--------------------------------

### Retrieve All Notifications and Access Individual Notification Details

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/notifications.md

This example demonstrates how to fetch all notification names using the `env0_notifications` data source and then iterate over them to retrieve individual notification details using the `env0_notification` data source. It also shows how to output specific notification names.

```terraform
data "env0_notifications" "all_notifications" {}

data "env0_notification" "notifications" {
  for_each = toset(data.env0_notifications.all_notifications.names)
  name     = each.value
}

output "notification1_name" {
  value = data.env0_notification.notifications["my notification 345"].name
}

output "notification2_name" {
  value = data.env0_notification.notifications["my notification 123"].name
}
```

--------------------------------

### Create an API Key with Combined Permissions and Team Assignment

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/api_key.md

This example illustrates creating an API key with both project-specific permissions and team assignment. The API key is granted 'Viewer' role in a project and assigned to a team.

```terraform
resource "env0_api_key" "combined_key" {
  name              = "combined-access-key"
  organization_role = "User"

  project_permissions {
    project_id   = env0_project.project.id
    project_role = "Viewer"
  }
}

resource "env0_user_team_assignment" "combined_team_assignment" {
  user_id = env0_api_key.combined_key.id
  team_id = env0_team.team_resource.id
}
```

--------------------------------

### Retrieve VCS Connection with CodeWrite Type

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/vcs_connection.md

This example demonstrates fetching a VCS connection specifically for the 'CodeWrite' connection type, which might be used for different integration purposes than 'DeploymentPipeline'.

```terraform
data "env0_vcs_connection" "github_codewrite" {
  access_scope    = "Organization:my-org"
  connection_type = "CodeWrite"
}
```

--------------------------------

### Create env0 Approval Policy and Assignment

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/approval_policy.md

Example of creating an env0 project, an approval policy associated with a GitHub repository, and assigning that policy to the project.

```terraform
resource "env0_project" "project" {
  name        = "project-name"
  description = "project-description"
}

resource "env0_approval_policy" "approval-policy" {
  name                   = "approval-policy-PROJECT-${env0_project.project.id}"
  repository             = "repo"
  github_installation_id = 1234
}

resource "env0_approval_policy_assignment" "assignment" {
  scope_id     = env0_project.project.id
  scope        = "PROJECT"
  blueprint_id = env0_approval_policy.approval-policy.id
}
```

--------------------------------

### Assign a User to an Environment with a Custom Role

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/user_environment_assignment.md

This example demonstrates how to assign a user (represented by an API key) to a specific environment using a custom role. Ensure the necessary data sources for template, project, and environment are defined, and that the API key and custom role resources are created prior to this assignment.

```terraform
data "env0_template" "template" {
  name = "Template Name"
}

data "env0_project" "project" {
  name = "Default Organization Project"
}

resource "env0_environment" "environment" {
  name        = "environment"
  project_id  = data.env0_project.project.id
  template_id = data.env0_template.template.id
}

resource "env0_api_key" "api_key" {
  name              = "user-api-key-sample"
  organization_role = "User"
}

resource "env0_custom_role" "custom_role" {
  name = "custom-role-sample"
  permissions = [
    "VIEW_PROJECT",
    "EDIT_PROJECT_SETTINGS"
  ]
}

resource "env0_user_environment_assignment" "assignment" {
  user_id        = env0_api_key.api_key.id
  environment_id = env0_environment.environment.id
  role_id        = env0_custom_role.custom_role.id
}
```

--------------------------------

### Assign an API Key to a Team

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/api_key.md

This example demonstrates assigning an API key to a team for team-based access control. It creates an API key and then associates it with a team resource.

```terraform
resource "env0_api_key" "team_api_key" {
  name = "team-api-key"
}

resource "env0_team" "team_resource" {
  name = "team-resource"
}

resource "env0_user_team_assignment" "api_key_team_assignment" {
  user_id = env0_api_key.team_api_key.id
  team_id = env0_team.team_resource.id
}
```

--------------------------------

### env0 Module Testing Project Data Source Example

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/module_testing_project.md

Use this data source to fetch the project ID for assigning agents and cloud credentials. It requires the env0_agents data source to be defined.

```terraform
data "env0_module_testing_project" "project" {}

data "env0_agents" "agents" {}

resource "env0_agent_project_assignment" "example" {
  agent_id   = data.env0_agents.agents.0.agent_key
  project_id = env0_module_testing_project.project.id
}
```

--------------------------------

### Create GitLab Enterprise VCS Connection with Custom Agent

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/vcs_connection.md

This example demonstrates creating a GitLab Enterprise VCS connection using a custom VCS agent key. Ensure the specified `vcs_agent_key` is configured in your env0 environment.

```terraform
resource "env0_vcs_connection" "gitlab_enterprise" {
  name          = "gitlab-enterprise"
  type          = "GitLabEnterprise"
  url           = "https://gitlab.example.com"
  vcs_agent_key = "my-custom-agent"
}
```

--------------------------------

### Get GitHub Installation ID

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/github_installation_id.md

Use this data source to fetch the GitHub installation ID for a specified repository. Ensure the repository URL is correctly provided.

```terraform
data "env0_github_installation_id" "example" {
  repository = "https://github.com/env0/templates"
}

output "github_installation_id" {
  value = data.env0_github_installation_id.example.github_installation_id
}
```

--------------------------------

### Create a Custom Flow with GitHub Enterprise

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/custom_flow.md

Example of creating a custom flow resource for GitHub Enterprise. It includes the name, repository URL, path, and explicitly sets `is_github_enterprise` to true.

```terraform
// Self Hosted VCS
resource "env0_custom_flow" "ghe_custom_flow" {
  name                 = "GHE Custom Flow"
  revision             = "my-revision"
  repository           = "https://mycompany.github.com/myorg/myrepo"
  path                 = "custom-flows/my-custom-flow.yaml"
  is_github_enterprise = true
}
```

--------------------------------

### Create a Custom Flow with GitHub Template

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/custom_flow.md

Example of creating a custom flow resource using an existing env0 GitHub template. It specifies the name, repository, and path for the custom flow definition.

```terraform
data "env0_template" "github_template" {
  name = "github_template"
}

resource "env0_custom_flow" "custom_flow" {
  name                   = "Custom Flow"
  repository             = data.env0_template.github_template.repository
  github_installation_id = data.env0_template.github_template.github_installation_id // The installation ID is taken from an existing authorized template
  path                   = "custom-flows/my-custom-flow.yaml"
}
```

--------------------------------

### Assign Team to Project with Custom Role

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/team_project_assignment.md

This example demonstrates assigning a team to a project using a custom role. First, define the custom role with its permissions, then create the assignment referencing the custom role's ID.

```terraform
resource "env0_custom_role" "custom_role_example" {
  name = "my custom role 1"
  permissions = [
    "VIEW_PROJECT",
    "EDIT_PROJECT_SETTINGS"
  ]
}

resource "env0_team_project_assignment" "role_assignment_custom_role_example" {
  team_id        = env0_team.team_resource.id
  project_id     = env0_project.project_example.id
  custom_role_id = env0_custom_role.custom_role_example.id
}
```

--------------------------------

### env0 Variable Set Data Source Example

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/variable_set.md

Use this data source to retrieve details of a variable set. Specify the name and scope (PROJECT or ORGANIZATION). For project-scoped variable sets, the project_id must also be provided.

```terraform
data "env0_project" "project" {
  name = "my project name"
}

data "env0_variable_set" "variable_set_project_scope" {
  name       = "variable set name"
  scope      = "PROJECT"
  project_id = data.env0_project.project.id
}

data "env0_variable_set" "variable_set_organization_scope" {
  name  = "variable set name"
  scope = "ORGANIZATION"
}
```

--------------------------------

### env0_source_code_variables Data Source Example

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/source_code_variables.md

Use this data source to fetch Terraform variables from a template's VCS configuration. Ensure the env0_template data source is configured to get the template ID.

```terraform
data "env0_template" "template" {
  name = "Template Name"
}

data "env0_source_code_variables" "variables" {
  template_id = data.env0_template.template.id
}

output "variable_0_value" {
  value = data.env0_source_code_variables.variables.0.value
}
```

--------------------------------

### Import env0 Approval Policy by ID

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/approval_policy.md

Demonstrates how to import an existing env0 approval policy using its unique ID.

```bash
terraform import env0_approval_policy.by_id ddda7b30-6789-4d24-937c-22322754934e
```

--------------------------------

### Generate Documentation

Source: https://github.com/env0/terraform-provider-env0/blob/main/README.md

Run the documentation generation script. This must be done manually before releasing a new version.

```shell
./generate-docs.sh
```

--------------------------------

### env0_source_code_variables Data Source

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/source_code_variables.md

Example usage of the env0_source_code_variables data source to fetch variables from a template.

```APIDOC
## env0_source_code_variables (Data Source)

### Description

This data source extracts source code terraform variables from the VCS configuration of a given env0 template.

### Method

GET

### Endpoint

/api/v1/templates/{template_id}/source-code-variables

### Parameters

#### Path Parameters

- **template_id** (String) - Required - The ID of the template to extract variables from.

### Request Example

```terraform
data "env0_template" "template" {
  name = "Template Name"
}

data "env0_source_code_variables" "variables" {
  template_id = data.env0_template.template.id
}

output "variable_0_value" {
  value = data.env0_source_code_variables.variables.0.value
}
```

### Response

#### Success Response (200)

- **variables** (List of Object) - A list of terraform variables extracted from the source code.
  - **description** (String) - The description of the variable.
  - **format** (String) - The format of the variable.
  - **name** (String) - The name of the variable.
  - **value** (String) - The value of the variable.

#### Response Example

```json
{
  "variables": [
    {
      "description": "Database username",
      "format": "string",
      "name": "DB_USER",
      "value": "admin"
    }
  ]
}
```
```

--------------------------------

### env0_aws_credentials Data Source Example

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/aws_credentials.md

Use this data source to retrieve AWS credentials by name or ID.

```terraform
data "env0_aws_credentials" "aws_credentials_by_name" {
  name = "aws credentials"
}

data "env0_aws_credentials" "aws_credentials_by_id" {
  id = "12345676safsd"
}
```

--------------------------------

### Get env0 Project Data

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/cloud_credentials_project_assignment.md

Retrieves data for a specific env0 project. Requires the project name.

```terraform
data "env0_project" "project" {
  name = "Default Organization Project"
}
```

--------------------------------

### Import env0 Approval Policy by Name

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/approval_policy.md

Shows how to import an existing env0 approval policy using its name, including the project scope.

```bash
terraform import env0_approval_policy.by_name "approval-policy-PROJECT-aaaa7b30-5784-4d24-937c-223227541111"
```

--------------------------------

### Basic Environment Discovery Configuration

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/environment_discovery_configuration.md

Configure environment discovery using a glob pattern and a GitHub repository. Specify the OpenTofu version for discovery.

```terraform
data "env0_project" "project" {
  name = "existing-project"
}

resource "env0_project" "new_project" {
  name = "new-project"
}

resource "env0_environment_discovery_configuration" "example" {
  project_id             = data.env0_project.project.id
  glob_pattern           = "**"
  repository             = "https://github.com/env0/templates"
  opentofu_version       = "1.6.7"
  github_installation_id = 12345
}
```

--------------------------------

### Generate Mocks

Source: https://github.com/env0/terraform-provider-env0/blob/main/README.md

Use the go generate command to create mock files. This requires adding a specific comment directive in your Go source files.

```shell
go generate ./...
```

--------------------------------

### Run All Unit Tests

Source: https://github.com/env0/terraform-provider-env0/blob/main/README.md

Execute all unit tests for the project from the root directory.

```shell
go test -v ./...
```

--------------------------------

### env0_provider Data Source

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/provider.md

Use the env0_provider data source to get information about a provider. You must provide the provider's ID.

```terraform
data "env0_provider" "provider" {
  id = "adsdasdasd-asdasdas"
}

```

--------------------------------

### Import env0 Provider by Type

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/provider.md

Import an existing env0 provider using its type name.

```shell
terraform import env0_provider.by_type aws
```

--------------------------------

### Import an Environment Output Configuration Variable by Name

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/environment_output_configuration_variable.md

Import an existing environment output configuration variable using its scope, scope ID, and name. Ensure the scope and scope ID match the variable's assignment.

```shell
terraform import env0_environment_output_configuration_variable.by_name '{"Scope": "PROJECT",  "ScopeId": "project_id",  "name": "variable name"}'
```

--------------------------------

### env0_notification Data Source

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/notification.md

Use the env0_notification data source to get the details of an existing notification. You must provide the notification's name.

```terraform
data "env0_notification" "my_notification" {
  name = "My Notification"
}
```

--------------------------------

### Get env0 environment by name

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/environment.md

Use this data source to retrieve an environment by its name. Ensure the environment name is unique within the project.

```terraform
data "env0_environment" "by_name" {
  name = "best-env"
}

output "environment_project_id" {
  value = data.env0_environment.by_name.project_id
}
```

--------------------------------

### Implement API Calls in Client

Source: https://github.com/env0/terraform-provider-env0/blob/main/DEVELOPMENT.md

Implement new API calls within the client directory. Use existing implementations as templates and ensure all relevant functions are added to the APIClient interface. Unit tests are required.

```go
package client

type APIClient interface {
	// ... other methods
}
```

--------------------------------

### Import env0 Provider by ID

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/provider.md

Import an existing env0 provider using its unique ID.

```shell
terraform import env0_provider.by_id ddda7b30-6789-4d24-937c-22322754934e
```

--------------------------------

### env0_aws_cost_credentials Data Source Example

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/aws_cost_credentials.md

Use this data source to retrieve AWS cost credentials by name or ID. Ensure the credentials exist in your env0 organization.

```terraform
data "env0_aws_cost_credentials" "aws_cost_credentials_by_name" {
  name = "aws cost credentials"
}

data "env0_aws_cost_credentials" "aws_cost_credentials_by_id" {
  id = "12345676safsd"
}
```

--------------------------------

### Get env0 environment by ID

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/environment.md

Use this data source to retrieve an environment by its unique ID. This is useful when the name might not be unique or for direct programmatic access.

```terraform
data "env0_environment" "by_id" {
  id = "some_id"
}

output "environment_name" {
  value = data.env0_environment.by_id.name
}
```

--------------------------------

### Import an Azure Cloud Configuration by Name

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/azure_cloud_configuration.md

Import an existing Azure cloud configuration by its name. This method is an alternative to importing by ID.

```shell
terraform import env0_azure_cloud_configuration.by_name "azure cloud configuration name"
```

--------------------------------

### Import an Environment Output Configuration Variable by ID

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/environment_output_configuration_variable.md

Import an existing environment output configuration variable using its scope, scope ID, and the variable's unique ID. This method is useful when the variable name might not be unique or known.

```shell
terraform import env0_environment_output_configuration_variable.by_id '{"Scope": "PROJECT",  "ScopeId": "project_id",  "id": "variable id"}'
```

--------------------------------

### env0_user Data Source Example

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/user.md

Use the env0_user data source to retrieve user information by email. The 'id' attribute will contain the user's unique identifier.

```terraform
data "env0_user" "user_by_email_example" {
  email = "john.doe@email.com"
}

output "user_id" {
  value = data.env0_user.user_by_email_example.id
}
```

--------------------------------

### Create a Basic Configuration Variable

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/configuration_variable.md

Use this to define a standard environment variable with a name, value, and optional description. The description has a character limit of 255.

```terraform
resource "env0_configuration_variable" "example" {
  name        = "ENVIRONMENT_VARIABLE_NAME"
  value       = "example value"
  description = "Here you can fill description for this variable, note this field have limit of 255 chars"
}
```

--------------------------------

### env0_oci_credentials Data Source Example

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/oci_credentials.md

Use the `env0_oci_credentials` data source to retrieve the ID of OCI credentials by name. This is useful for referencing existing credentials in your Terraform configurations.

```terraform
data "env0_oci_credentials" "example" {
  name = "my-oci-credentials"
}

output "oci_credentials_id" {
  value = data.env0_oci_credentials.example.id
}
```

--------------------------------

### env0_google_cost_credentials Data Source Example

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/data-sources/google_cost_credentials.md

Use this data source to retrieve Google Cloud cost credentials by name or ID. Ensure the credentials exist in your env0 organization.

```terraform
data "env0_google_cost_credentials" "google_cost_credentials_by_name" {
  name = "google cost credentials"
}

data "env0_google_cost_credentials" "google_cost_credentials_by_id" {
  id = "12345676safsd"
}
```

--------------------------------

### Import Project Configuration Variable

Source: https://github.com/env0/terraform-provider-env0/blob/main/docs/resources/configuration_variable.md

Import an existing configuration variable associated with a specific project. Ensure the resource block includes the `project_id` argument.

```shell
# For project variables: include a resource block that passes the project_id argument
terraform import env0_configuration_variable.my_project_config "{ \"Scope\": \"PROJECT\", \"ScopeId\": \"project id\", \"name\": \"configuration variable name\"}"
```