Note

This repository is publicly accessible as part of our open-source initiative. We welcome contributions from the community alongside our organization's primary development efforts.

---

terraform-module-template

Terraform Module Template

Usage

This example demonstrates the usage of this Terraform module with default settings.

resource "azurerm_resource_group" "example" {
  name     = "rg-example-dev-euw-01"
  location = "westeurope"
}

resource "azurerm_virtual_network" "example" {
  name                = "vnet-example-dev-euw-01"
  resource_group_name = azurerm_resource_group.example.name
  location            = azurerm_resource_group.example.location

  address_space = ["10.0.0.0/8"]
}

resource "azurerm_subnet" "example" {
  name                 = "snet-example"
  resource_group_name  = azurerm_resource_group.example.name
  virtual_network_name = azurerm_virtual_network.example.name

  address_prefixes = ["10.1.0.0/16"]
}


module "example" {
  source = "cloudeteer/ai/azurerm"

  name                = "oai-example-dev-euw-01"
  resource_group_name = azurerm_resource_group.example.name
  location            = azurerm_resource_group.example.location

  subnet_id = azurerm_subnet.example.id

  kind     = "OpenAI"
  sku_name = "S0"

  models = [
    {
      rai_policy_name = "Microsoft.Default"
      format          = "OpenAI"
      name            = "gpt-4o-mini"
      version         = "2024-07-18"
      sku = {
        name     = "GlobalStandard"
        capacity = 100
      }
    }
  ]
}

Providers

The following providers are used by this module:

• azurerm (>= 3.0)

Resources

The following resources are used by this module:

• azurerm_cognitive_account.this (resource)
• azurerm_cognitive_deployment.this (resource)
• azurerm_private_dns_zone.this (resource)
• azurerm_private_dns_zone_virtual_network_link.this (resource)
• azurerm_private_endpoint.this (resource)

Required Inputs

The following input variables are required:

kind

Description: Specifies the type of Cognitive Service Account that should be created. Possible values are:

• Academic
• AnomalyDetector
• Bing.Autosuggest.v7
• Bing.Autosuggest
• Bing.CustomSearch
• Bing.Search.v7
• Bing.Search
• Bing.Speech
• Bing.SpellCheck.v7
• Bing.SpellCheck
• CognitiveServices
• ComputerVision
• ContentModerator
• ContentSafety
• CustomSpeech
• CustomVision.Prediction
• CustomVision.Training
• Emotion
• Face
• FormRecognizer
• ImmersiveReader
• LUIS.Authoring
• LUIS
• MetricsAdvisor
• OpenAI
• Personalizer
• QnAMaker
• Recommendations
• SpeakerRecognition
• Speech
• SpeechServices
• SpeechTranslation
• TextAnalytics
• `TextTranslation
• WebLM `

Type: string

location

Description: Specifies the supported Azure location where the resource exists.

Type: string

name

Description: Specifies the name of the Cognitive Service Account.

Type: string

resource_group_name

Description: The name of the resource group in which the Cognitive Service Account is created.

Type: string

sku_name

Description: Specifies the SKU Name for this Cognitive Service Account. Possible values are F0, F1, S0, S, S1, S2, S3, S4, S5, S6, P0, P1, P2, E0 and DC0.

Type: string

subnet_id

Description: The ID of the subnet which should be able to access this Cognitive Account.

Type: string

Optional Inputs

The following input variables are optional (have default values):

custom_subdomain_name

Description: The subdomain name used for token-based authentication.

Type: string

Default: null

models

Description: value

Type: list(any)

Default: []

public_network_access_enabled

Description: Whether public network access is allowed for the Cognitive Account.

Type: bool

Default: false

tags

Description: A mapping of tags which should be assigned to all resources in this module.

Type: map(string)

Default: null

Outputs

The following outputs are exported:

endpoint

Description: The endpoint used to connect to the Cognitive Service Account.

primary_access_key

Description: A primary access key which can be used to connect to the Cognitive Service Account.

secondary_access_key

Description: The secondary access key which can be used to connect to the Cognitive Service Account.

Contributions

We welcome all kinds of contributions, whether it's reporting bugs, submitting feature requests, or directly contributing to the development. Please read our Contributing Guidelines to learn how you can best contribute.

Thank you for your interest and support!

Copyright and license

© 2024 CLOUDETEER GmbH

This project is licensed under the MIT License.