{"id":395,"date":"2024-07-21T19:08:13","date_gmt":"2024-07-21T09:08:13","guid":{"rendered":"https:\/\/www.cloudproinc.com.au\/?p=395"},"modified":"2024-07-21T19:08:18","modified_gmt":"2024-07-21T09:08:18","slug":"retrieving-azure-ai-services-keys-and-endpoints-using-bicep","status":"publish","type":"post","link":"https:\/\/www.cloudproinc.com.au\/index.php\/2024\/07\/21\/retrieving-azure-ai-services-keys-and-endpoints-using-bicep\/","title":{"rendered":"Retrieving Azure AI Services Keys and Endpoints Using Bicep"},"content":{"rendered":"\n

This Azure AI Services post will show how to retrieve Azure AI Services keys and Endpoint using Bicep deployment code.<\/p>\n\n\n\n\n\n\n\n

If you are not familiar with Azure Bicep, it is a Specific Domain Language (DSL) for infrastructure-as-code (iac) deployments in Azure only. <\/p>\n\n\n\n

Unlike other tools like Terraform, Bicep offers access to the latest Azure API from day one. By default (the only option), Bicep saves the deployment’s state files in Azure and does not use a local copy.<\/p>\n\n\n\n

Retrieving Azure AI Services Keys and Endpoints Using Bicep<\/h2>\n\n\n\n

When deploying services to Azure that contains a security key and endpoint URL, we can use native Bicep functionality to retrieve those details after the deployment is complete.<\/p>\n\n\n\n

The following Bicep code will deploy an Azure AI Services resource and output the key and Endpoint details.<\/p>\n\n\n\n

Before running this code, Install Bicep on your machine using the following command (Windows only).<\/p>\n\n\n\n

winget install -e --id Microsoft.Bicep<\/code><\/pre>\n\n\n\n
Login to Azure using Azure PowerShell <\/p>\n\n\n\n
Connect-AzAccount -UseDeviceAuthentication<\/code><\/pre>\n\n\n\n
Create a resource group <\/p>\n\n\n\n
New-AzResourceGroup -Name \"RG-NAME\" -Location \"australiasoutheast\"<\/code><\/pre>\n\n\n\n
After creating a resource group, we are almost ready to deploy the Bicep template. Copy the template to a file called main.bicep.<\/p>\n\n\n\n
\nresource aiservice 'Microsoft.CognitiveServices\/accounts@2023-05-01' = {\n  name: 'CognitiveServices'\n  location: 'southeastasia'\n \n  sku: {\n    name: 'S0'\n  }\n  kind: 'CognitiveServices'\n  properties: {\n   \n  }\n \n}\n\n\noutput cognitiveServiceEndpoint string = aiservice.properties.endpoint\noutput cognitiveServiceKey string = listKeys(aiservice.id, '2022-12-01').key1\n\n\n\n\n<\/code><\/pre>\n\n\n\n
After saving the file from the terminal window, open the location of the directory with the Bicep file and run the following command to deploy the service and retrieve the key and endpoint.<\/p>\n\n\n\n
New-AzResourceGroupDeployment -ResourceGroupName \"RG-NAME\" -TemplateFile .\\main.bicep<\/code><\/pre>\n\n\n\n
Note: In a production environment, it is not recommended that the key be outputted to the terminal. Ideally, you should use a secure string that outputs the key but does not save it in the terminal history.<\/p>\n\n\n\n