This Terraform module is designed to manage Azure Cognitive Services. It provides a comprehensive set of variables and resources to configure and deploy Cognitive Services in Azure.
Important
As the overall AVM framework is not GA (generally available) yet - the CI framework and test automation is not fully functional and implemented across all supported languages yet - breaking changes are expected, and additional customer feedback is yet to be gathered and incorporated. Hence, modules MUST NOT be published at version 1.0.0 or higher at this time.
All module MUST be published as a pre-release version (e.g., 0.1.0, 0.1.1, 0.2.0, etc.) until the AVM framework becomes GA.
However, it is important to note that this DOES NOT mean that the modules cannot be consumed and utilized. They CAN be leveraged in all types of environments (dev, test, prod etc.). Consumers can treat them just like any other IaC module and raise issues or feature requests against them as they learn from the usage of the module. Consumers should also read the release notes for each version, if considering updating to a more recent version of a module to see if there are any considerations or breaking changes etc.
The following requirements are needed by this module:
The following providers are used by this module:
The following resources are used by this module:
- azurerm_cognitive_account.this (resource)
- azurerm_cognitive_account_customer_managed_key.this (resource)
- azurerm_cognitive_deployment.this (resource)
- azurerm_management_lock.this (resource)
- azurerm_monitor_diagnostic_setting.this (resource)
- azurerm_private_endpoint.this (resource)
- azurerm_private_endpoint_application_security_group_association.this (resource)
- azurerm_resource_group_template_deployment.telemetry (resource)
- azurerm_role_assignment.this (resource)
- random_id.telemetry (resource)
- random_string.default_custom_subdomain_name_suffix (resource)
- azurerm_key_vault_key.this (data source)
- azurerm_user_assigned_identity.this (data source)
The following input variables are required:
Description: (Required) Specifies the type of Cognitive Service Account that should be created. Possible values are Academic, AnomalyDetector, Bing.Autosuggest, Bing.Autosuggest.v7, Bing.CustomSearch, Bing.Search, Bing.Search.v7, Bing.Speech, Bing.SpellCheck, Bing.SpellCheck.v7, CognitiveServices, ComputerVision, ContentModerator, ContentSafety, CustomSpeech, CustomVision.Prediction, CustomVision.Training, Emotion, Face, FormRecognizer, ImmersiveReader, LUIS, LUIS.Authoring, MetricsAdvisor, OpenAI, Personalizer, QnAMaker, Recommendations, SpeakerRecognition, Speech, SpeechServices, SpeechTranslation, TextAnalytics, TextTranslation and WebLM. Changing this forces a new resource to be created.
Type: string
Description: (Required) Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Type: string
Description: (Required) Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
Type: string
Description: (Required) The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.
Type: string
Description: (Required) 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
The following input variables are optional (have default values):
Description: - name - (Required) The name of the Cognitive Services Account Deployment. Changing this forces a new resource to be created.
rai_policy_name- (Optional) The name of RAI policy.version_upgrade_option- (Optional) Deployment model version upgrade option. Possible values areOnceNewDefaultVersionAvailable,OnceCurrentVersionExpired, andNoAutoUpgrade. Defaults toOnceNewDefaultVersionAvailable. Changing this forces a new resource to be created.
model block supports the following:
format- (Required) The format of the Cognitive Services Account Deployment model. Changing this forces a new resource to be created. Possible value isOpenAI.name- (Required) The name of the Cognitive Services Account Deployment model. Changing this forces a new resource to be created.version- (Optional) The version of Cognitive Services Account Deployment model. Ifversionis not specified, the default version of the model at the time will be assigned.
scale block supports the following:
capacity- (Optional) Tokens-per-Minute (TPM). The unit of measure for this field is in the thousands of Tokens-per-Minute. Defaults to1which means that the limitation is1000tokens per minute. If the resources SKU supports scale in/out then the capacity field should be included in the resources' configuration. If the scale in/out is not supported by the resources SKU then this field can be safely omitted. For more information about TPM please see the product documentation.family- (Optional) If the service has different generations of hardware, for the same SKU, then that can be captured here. Changing this forces a new resource to be created.size- (Optional) The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. Changing this forces a new resource to be created.tier- (Optional) Possible values areFree,Basic,Standard,Premium,Enterprise. Changing this forces a new resource to be created.type- (Required) The name of the SKU. Ex
timeouts block supports the following:
create- (Defaults to 30 minutes) Used when creating the Cognitive Services Account Deployment.delete- (Defaults to 30 minutes) Used when deleting the Cognitive Services Account Deployment.read- (Defaults to 5 minutes) Used when retrieving the Cognitive Services Account Deployment.update- (Defaults to 30 minutes) Used when updating the Cognitive Services Account Deployment.
Type:
map(object({
name = string
rai_policy_name = optional(string)
version_upgrade_option = optional(string)
model = object({
format = string
name = string
version = string
})
scale = object({
capacity = optional(number)
family = optional(string)
size = optional(string)
tier = optional(string)
type = string
})
timeouts = optional(object({
create = optional(string)
delete = optional(string)
read = optional(string)
update = optional(string)
}))
}))Default: {}
Description: (Optional) If kind is TextAnalytics this specifies the ID of the Search service.
Type: string
Default: null
Description: (Optional) If kind is TextAnalytics this specifies the key of the Search service.
Type: string
Default: null
Description: (Optional) The subdomain name used for token-based authentication. This property is required when network_acls is specified. Changing this forces a new resource to be created.
Type: string
Default: null
Description: Controls the Customer managed key configuration on this resource. The following properties can be specified:
key_vault_resource_id- (Required) Resource ID of the Key Vault that the customer managed key belongs to.key_name- (Required) Specifies the name of the Customer Managed Key Vault Key.key_version- (Optional) The version of the Customer Managed Key Vault Key.user_assigned_identity- (Optional) The User Assigned Identity that has access to the key.resource_id- (Required) The resource ID of the User Assigned Identity that has access to the key.
Type:
object({
key_vault_resource_id = string
key_name = string
key_version = optional(string, null)
user_assigned_identity = optional(object({
resource_id = string
}), null)
timeouts = optional(object({
create = optional(string)
delete = optional(string)
read = optional(string)
update = optional(string)
}))
})Default: null
Description: A map of diagnostic settings to create on the Key Vault. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
name- (Optional) The name of the diagnostic setting. One will be generated if not set, however this will not be unique if you want to create multiple diagnostic setting resources.log_categories- (Optional) A set of log categories to send to the log analytics workspace. Defaults to[].log_groups- (Optional) A set of log groups to send to the log analytics workspace. Defaults to["allLogs"].metric_categories- (Optional) A set of metric categories to send to the log analytics workspace. Defaults to["AllMetrics"].log_analytics_destination_type- (Optional) The destination type for the diagnostic setting. Possible values areDedicatedandAzureDiagnostics. Defaults toDedicated.workspace_resource_id- (Optional) The resource ID of the log analytics workspace to send logs and metrics to.storage_account_resource_id- (Optional) The resource ID of the storage account to send logs and metrics to.event_hub_authorization_rule_resource_id- (Optional) The resource ID of the event hub authorization rule to send logs and metrics to.event_hub_name- (Optional) The name of the event hub. If none is specified, the default event hub will be selected.marketplace_partner_resource_id- (Optional) The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic LogsLogs.
Type:
map(object({
name = optional(string, null)
log_categories = optional(set(string), [])
log_groups = optional(set(string), ["allLogs"])
metric_categories = optional(set(string), ["AllMetrics"])
log_analytics_destination_type = optional(string, "Dedicated")
workspace_resource_id = optional(string, null)
storage_account_resource_id = optional(string, null)
event_hub_authorization_rule_resource_id = optional(string, null)
event_hub_name = optional(string, null)
marketplace_partner_resource_id = optional(string, null)
}))Default: {}
Description: (Optional) Whether to enable the dynamic throttling for this Cognitive Service Account.
Type: bool
Default: null
Description: This variable controls whether or not telemetry is enabled for the module.
For more information see https://aka.ms/avm/telemetryinfo.
If it is set to false, then no telemetry will be collected.
Type: bool
Default: true
Description: (Optional) List of FQDNs allowed for the Cognitive Account.
Type: list(string)
Default: null
Description: (Optional) Whether local authentication methods is enabled for the Cognitive Account. Defaults to true.
Type: bool
Default: null
Description: Controls the Resource Lock configuration for this resource. The following properties can be specified:
kind- (Required) The type of lock. Possible values are\"CanNotDelete\"and\"ReadOnly\".name- (Optional) The name of the lock. If not specified, a name will be generated based on thekindvalue. Changing this forces the creation of a new resource.
Type:
object({
kind = string
name = optional(string, null)
})Default: null
Description: Controls the Managed Identity configuration on this resource. The following properties can be specified:
system_assigned- (Optional) Specifies if the System Assigned Managed Identity should be enabled.user_assigned_resource_ids- (Optional) Specifies a list of User Assigned Managed Identity resource IDs to be assigned to this resource.
Type:
object({
system_assigned = optional(bool, false)
user_assigned_resource_ids = optional(set(string), [])
})Default: {}
Description: (Optional) The Azure AD Client ID (Application ID). This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
Type: string
Default: null
Description: (Optional) The Azure AD Tenant ID. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
Type: string
Default: null
Description: (Optional) The super user of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
Type: string
Default: null
Description: (Optional) The website name of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
Type: string
Default: null
Description: - default_action - (Required) The Default Action to use when no rules match from ip_rules / virtual_network_rules. Possible values are Allow and Deny.
ip_rules- (Optional) One or more IP Addresses, or CIDR Blocks which should be able to access the Cognitive Account.
virtual_network_rules block supports the following:
ignore_missing_vnet_service_endpoint- (Optional) Whether ignore missing vnet service endpoint or not. Default tofalse.subnet_id- (Required) The ID of the subnet which should be able to access this Cognitive Account.
Type:
object({
default_action = string
ip_rules = optional(set(string))
virtual_network_rules = optional(set(object({
ignore_missing_vnet_service_endpoint = optional(bool)
subnet_id = string
})))
})Default: null
Description: (Optional) Whether outbound network access is restricted for the Cognitive Account. Defaults to false.
Type: bool
Default: null
Description: A map of private endpoints to create on the Key Vault. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
name- (Optional) The name of the private endpoint. One will be generated if not set.role_assignments- (Optional) A map of role assignments to create on the private endpoint. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time. Seevar.role_assignmentsfor more information.lock- (Optional) The lock level to apply to the private endpoint. Default isNone. Possible values areNone,CanNotDelete, andReadOnly.tags- (Optional) A mapping of tags to assign to the private endpoint.subnet_resource_id- The resource ID of the subnet to deploy the private endpoint in.private_dns_zone_group_name- (Optional) The name of the private DNS zone group. One will be generated if not set.private_dns_zone_resource_ids- (Optional) A set of resource IDs of private DNS zones to associate with the private endpoint. If not set, no zone groups will be created and the private endpoint will not be associated with any private DNS zones. DNS records must be managed external to this module.application_security_group_resource_ids- (Optional) A map of resource IDs of application security groups to associate with the private endpoint. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.private_service_connection_name- (Optional) The name of the private service connection. One will be generated if not set.network_interface_name- (Optional) The name of the network interface. One will be generated if not set.location- (Optional) The Azure location where the resources will be deployed. Defaults to the location of the resource group.resource_group_name- (Optional) The resource group where the resources will be deployed. Defaults to the resource group of the Key Vault.ip_configurations- (Optional) A map of IP configurations to create on the private endpoint. If not specified the platform will create one. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.name- The name of the IP configuration.private_ip_address- The private IP address of the IP configuration.
Type:
map(object({
name = optional(string, null)
role_assignments = optional(map(object({})), {})
lock = optional(object({}), {})
tags = optional(map(any), null)
subnet_resource_id = string
private_dns_zone_group_name = optional(string, "default")
private_dns_zone_resource_ids = optional(set(string), [])
application_security_group_associations = optional(map(string), {})
private_service_connection_name = optional(string, null)
network_interface_name = optional(string, null)
location = optional(string, null)
resource_group_name = optional(string, null)
ip_configurations = optional(map(object({
name = string
private_ip_address = string
})), {})
}))Default: {}
Description: (Optional) Whether public network access is allowed for the Cognitive Account. Defaults to true.
Type: bool
Default: null
Description: (Optional) A URL to link a QnAMaker cognitive account to a QnA runtime.
Type: string
Default: null
Description: A map of role assignments to create on the Key Vault. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.
role_definition_id_or_name- The ID or name of the role definition to assign to the principal.principal_id- The ID of the principal to assign the role to.description- The description of the role assignment.skip_service_principal_aad_check- If set to true, skips the Azure Active Directory check for the service principal in the tenant. Defaults to false.condition- The condition which will be used to scope the role assignment.condition_version- The version of the condition syntax. Leave asnullif you are not using a condition, if you are then valid values are '2.0'.
Note: only set
skip_service_principal_aad_checkto true if you are assigning a role to a service principal.
Type:
map(object({
role_definition_id_or_name = string
principal_id = string
description = optional(string, null)
skip_service_principal_aad_check = optional(bool, false)
condition = optional(string, null)
condition_version = optional(string, null)
delegated_managed_identity_resource_id = optional(string, null)
}))Default: {}
Description: - identity_client_id - (Optional) The client ID of the managed identity associated with the storage resource.
storage_account_id- (Required) Full resource id of a Microsoft.Storage resource.
Type:
list(object({
identity_client_id = optional(string)
storage_account_id = string
}))Default: null
Description: (Optional) A mapping of tags to assign to the resource.
Type: map(string)
Default: null
Description: - create - (Defaults to 30 minutes) Used when creating the Cognitive Service Account.
delete- (Defaults to 30 minutes) Used when deleting the Cognitive Service Account.read- (Defaults to 5 minutes) Used when retrieving the Cognitive Service Account.update- (Defaults to 30 minutes) Used when updating the Cognitive Service Account.
Type:
object({
create = optional(string)
delete = optional(string)
read = optional(string)
update = optional(string)
})Default: null
The following outputs are exported:
Description: The name of cognitive account created.
Description: A map of the private endpoints created.
Description: The cognitive account resource created.
Description: The map of cognitive deployments created.
Description: The resource ID of cognitive account created.
Description: The principal ID of system assigned managed identity on the cognitive account created, when var.managed_identities is null or var.managed_identities.system_assigned is false this output is null.
No modules.
The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.