cognitive_services/cognitive_services_account¶

Overview¶

This page documents the Terraform module implementation, key configuration surfaces, and how it integrates with CAF.

Dependency diagram (Mermaid)¶

graph TD azurecaf_name.service["azurecaf_name.service"] azurerm_cognitive_account.service["azurerm_cognitive_account.service"] module.diagnostics["module.diagnostics"] module.private_endpoint["module.private_endpoint"] azurerm_cognitive_account.service --> azurecaf_name.service module.diagnostics --> azurerm_cognitive_account.service module.private_endpoint --> azurerm_cognitive_account.service

Module Reference¶

Category: cognitive_services
Path: modules/cognitive_services/cognitive_services_account
Azure Resources: azurecaf_name, azurerm_cognitive_account

Inputs¶

Name	Description	Type	Required	Default	Validation
`global_settings`	Global settings object (see module README.md)	`any`	yes	`-`	-
`client_config`	Client configuration object (see module README.md).	`any`	yes	`-`	-
`location`	(Required) Specifies the supported Azure location where to create the resource. Changing this forces a new resource t...	`string`	yes	`-`	-
`settings`	The settings object is a map of objects. Each object represents a Cognitive Service Account. The object has the follo...	`any`	yes	`-`	-
`remote_objects`	Remote objects is a map of objects. Each object represents a remote object that the Cognitive Service Account depends...	`any`	no	`{}`	-
`private_endpoints`	A map of objects representing the private endpoints to create.	`any`	no	`{}`	-
`base_tags`	Base tags for the resource to be inherited from the resource group.	`bool`	yes	`-`	-
`resource_group`	Resource group object	`any`	yes	`-`	-
`resource_group_name`	The name of the resource group in which to create the Cognitive Service Account.	`string`	yes	`-`	-

Outputs¶

Name	Description	Sensitive	Value
`id`	The ID of the Cognitive Service Account.	-	`azurerm_cognitive_account.service.id`
`endpoint`	The endpoint used to connect to the Cognitive Service Account.	-	`azurerm_cognitive_account.service.endpoint`
`identity`	The identity associated with the Cognitive Service Account.	-	`azurerm_cognitive_account.service.identity`
`identity_principal_id`	The Principal ID associated with the identity of the Cognitive Service Account.	-	`try(azurerm_cognitive_account.service.identity[0].principal_id, null)`
`identity_tenant_id`	The Tenant ID associated with the identity of the Cognitive Service Account.	-	`try(azurerm_cognitive_account.service.identity[0].tenant_id, null)`
`primary_access_key`	The primary access key associated with the Cognitive Service Account.	-	`azurerm_cognitive_account.service.primary_access_key`
`secondary_access_key`	The secondary access key associated with the Cognitive Service Account.	-	`azurerm_cognitive_account.service.secondary_access_key`

Sources¶

modules/cognitive_services/cognitive_services_account/cognitive_service_account.tf
modules/cognitive_services/cognitive_services_account/diagnostics.tf
modules/cognitive_services/cognitive_services_account/locals.tf
modules/cognitive_services/cognitive_services_account/main.tf
modules/cognitive_services/cognitive_services_account/managed_identities.tf
modules/cognitive_services/cognitive_services_account/outputs.tf
modules/cognitive_services/cognitive_services_account/private_endpoint.tf
modules/cognitive_services/cognitive_services_account/variables.tf