Added Environment Variables for setting Names of Resources (#1389)

* Added Environment Variables to allow setting the names of most resources.
+ App Service Plan Name
+ App Service Name (backend service)
+ Application Insights Name
+ Application Insights Dashboard Name
+ Log Analytics Workspace Name

Two Global Resources are created, whose names have not been parameterised. These are
- Action group (Application Insights Smart Detection)
- Smart detector alert rule (Failure Anomalies - $AZURE_APPLICATION_INSIGHTS)

* Added Environment Variables for Computer Vision Name, RG, Location and SKU Parameters

* Computer Vision SKU - Removed incorrect default

* Update azure-dev.yml

Added ENV Variables also to workflow

* Updated deploy_existing.md and pipelines.

* Updated main.bicep variables to show reference to main.parameters.json file. Updated some defaults.

* Expanded allow-list of Document Intelligence regions.

* Reverted my change of Document Intelligence resource locations, since the Preview API is only available in the listed three locations.

* Add empty string default back

* update toc

* bring back comment

---------

Co-authored-by: Pamela Fox <[email protected]>
Co-authored-by: Pamela Fox <[email protected]>

Author: giterinhub

.azdo/pipelines/azure-dev.yml

@@ -46,9 +46,10 @@ steps:
       AZURE_OPENAI_SERVICE: $(AZURE_OPENAI_SERVICE)
       AZURE_OPENAI_API_VERSION: $(AZURE_OPENAI_API_VERSION)
       AZURE_OPENAI_RESOURCE_GROUP: $(AZURE_OPENAI_RESOURCE_GROUP)
-      AZURE_FORMRECOGNIZER_SERVICE: $(AZURE_FORMRECOGNIZER_SERVICE)
-      AZURE_FORMRECOGNIZER_RESOURCE_GROUP: $(AZURE_FORMRECOGNIZER_RESOURCE_GROUP)
-      AZURE_FORMRECOGNIZER_SKU: $(AZURE_FORMRECOGNIZER_SKU)
+      AZURE_DOCUMENTINTELLIGENCE_SERVICE: $(AZURE_DOCUMENTINTELLIGENCE_SERVICE)
+      AZURE_DOCUMENTINTELLIGENCE_RESOURCE_GROUP: $(AZURE_DOCUMENTINTELLIGENCE_RESOURCE_GROUP)
+      AZURE_DOCUMENTINTELLIGENCE_SKU: $(AZURE_DOCUMENTINTELLIGENCE_SKU)
+      AZURE_DOCUMENTINTELLIGENCE_LOCATION: $(AZURE_DOCUMENTINTELLIGENCE_LOCATION)
       AZURE_SEARCH_INDEX: $(AZURE_SEARCH_INDEX)
       AZURE_SEARCH_SERVICE: $(AZURE_SEARCH_SERVICE)
       AZURE_SEARCH_SERVICE_RESOURCE_GROUP: $(AZURE_SEARCH_SERVICE_RESOURCE_GROUP)
@@ -73,10 +74,17 @@ steps:
       OPENAI_API_KEY: $(OPENAI_API_KEY)
       OPENAI_ORGANIZATION: $(OPENAI_ORGANIZATION)
       AZURE_USE_APPLICATION_INSIGHTS: $(AZURE_USE_APPLICATION_INSIGHTS)
+      AZURE_APPLICATION_INSIGHTS: $(AZURE_APPLICATION_INSIGHTS)
+      AZURE_APPLICATION_INSIGHTS_DASHBOARD: $(AZURE_APPLICATION_INSIGHTS_DASHBOARD)
+      AZURE_LOG_ANALYTICS: $(AZURE_LOG_ANALYTICS)
       USE_VECTORS: $(USE_VECTORS)
       USE_GPT4V: $(USE_GPT4V)
       AZURE_VISION_ENDPOINT: $(AZURE_VISION_ENDPOINT)
       VISION_SECRET_NAME: $(VISION_SECRET_NAME)
+      AZURE_COMPUTER_VISION_SERVICE: $(AZURE_COMPUTER_VISION_SERVICE)
+      AZURE_COMPUTER_VISION_RESOURCE_GROUP: $(AZURE_COMPUTER_VISION_RESOURCE_GROUP)
+      AZURE_COMPUTER_VISION_LOCATION: $(AZURE_COMPUTER_VISION_LOCATION)
+      AZURE_COMPUTER_VISION_SKU: $(AZURE_COMPUTER_VISION_SKU)
       AZURE_KEY_VAULT_NAME: $(AZURE_KEY_VAULT_NAME)
       AZURE_USE_AUTHENTICATION: $(AZURE_USE_AUTHENTICATION)
       AZURE_ENFORCE_ACCESS_CONTROL: $(AZURE_ENFORCE_ACCESS_CONTROL)

.github/workflows/azure-dev.yml

@@ -32,6 +32,10 @@ jobs:
       AZURE_OPENAI_SERVICE: ${{ vars.AZURE_OPENAI_SERVICE }}
       AZURE_OPENAI_API_VERSION: ${{ vars.AZURE_OPENAI_API_VERSION }}
       AZURE_OPENAI_RESOURCE_GROUP: ${{ vars.AZURE_OPENAI_RESOURCE_GROUP }}
+      AZURE_COMPUTER_VISION_SERVICE: ${{ vars.AZURE_COMPUTER_VISION_SERVICE }}
+      AZURE_COMPUTER_VISION_RESOURCE_GROUP: ${{ vars.AZURE_COMPUTER_VISION_RESOURCE_GROUP }}
+      AZURE_COMPUTER_VISION_LOCATION: ${{ vars.AZURE_COMPUTER_VISION_LOCATION }}
+      AZURE_COMPUTER_VISION_SKU: ${{ vars.AZURE_COMPUTER_VISION_SKU }}
       AZURE_FORMRECOGNIZER_SERVICE: ${{ vars.AZURE_FORMRECOGNIZER_SERVICE }}
       AZURE_FORMRECOGNIZER_RESOURCE_GROUP: ${{ vars.AZURE_FORMRECOGNIZER_RESOURCE_GROUP }}
       AZURE_FORMRECOGNIZER_SKU: ${{ vars.AZURE_FORMRECOGNIZER_SKU }}
@@ -46,7 +50,9 @@ jobs:
       AZURE_STORAGE_ACCOUNT: ${{ vars.AZURE_STORAGE_ACCOUNT }}
       AZURE_STORAGE_RESOURCE_GROUP: ${{ vars.AZURE_STORAGE_RESOURCE_GROUP }}
       AZURE_STORAGE_SKU: ${{ vars.AZURE_STORAGE_SKU }}
+      AZURE_APP_SERVICE_PLAN: ${{ vars.AZURE_APP_SERVICE_PLAN }}
       AZURE_APP_SERVICE_SKU: ${{ vars.AZURE_APP_SERVICE_SKU }}
+      AZURE_APP_SERVICE: ${{ vars.AZURE_APP_SERVICE }}
       AZURE_OPENAI_CHATGPT_MODEL: ${{ vars.AZURE_OPENAI_CHATGPT_MODEL }}
       AZURE_OPENAI_CHATGPT_DEPLOYMENT: ${{ vars.AZURE_OPENAI_CHATGPT_DEPLOYMENT }}
       AZURE_OPENAI_CHATGPT_DEPLOYMENT_CAPACITY: ${{ vars.AZURE_OPENAI_CHATGPT_DEPLOYMENT_CAPACITY }}
@@ -59,6 +65,9 @@ jobs:
       OPENAI_API_KEY: ${{ vars.OPENAI_API_KEY }}
       OPENAI_ORGANIZATION: ${{ vars.OPENAI_ORGANIZATION }}
       AZURE_USE_APPLICATION_INSIGHTS: ${{ vars.AZURE_USE_APPLICATION_INSIGHTS }}
+      AZURE_APPLICATION_INSIGHTS: ${{ vars.AZURE_APPLICATION_INSIGHTS }}
+      AZURE_APPLICATION_INSIGHTS_DASHBOARD: ${{ vars.AZURE_APPLICATION_INSIGHTS_DASHBOARD }}
+      AZURE_LOG_ANALYTICS: ${{ vars.AZURE_LOG_ANALYTICS }}
       USE_VECTORS: ${{ vars.USE_VECTORS }}
       USE_GPT4V: ${{ vars.USE_GPT4V }}
       AZURE_VISION_ENDPOINT: ${{ vars.AZURE_VISION_ENDPOINT }}

azure.yaml

@@ -25,9 +25,10 @@ pipeline:
       - AZURE_OPENAI_SERVICE
       - AZURE_OPENAI_API_VERSION
       - AZURE_OPENAI_RESOURCE_GROUP
-      - AZURE_FORMRECOGNIZER_SERVICE
-      - AZURE_FORMRECOGNIZER_RESOURCE_GROUP
-      - AZURE_FORMRECOGNIZER_SKU
+      - AZURE_DOCUMENTINTELLIGENCE_SERVICE
+      - AZURE_DOCUMENTINTELLIGENCE_RESOURCE_GROUP
+      - AZURE_DOCUMENTINTELLIGENCE_SKU
+      - AZURE_DOCUMENTINTELLIGENCE_LOCATION
       - AZURE_SEARCH_INDEX
       - AZURE_SEARCH_SERVICE
       - AZURE_SEARCH_SERVICE_RESOURCE_GROUP
@@ -39,7 +40,9 @@ pipeline:
       - AZURE_STORAGE_ACCOUNT
       - AZURE_STORAGE_RESOURCE_GROUP
       - AZURE_STORAGE_SKU
+      - AZURE_APP_SERVICE
       - AZURE_APP_SERVICE_SKU
+      - AZURE_APP_SERVICE_PLAN
       - AZURE_OPENAI_CHATGPT_MODEL
       - AZURE_OPENAI_CHATGPT_DEPLOYMENT
       - AZURE_OPENAI_CHATGPT_DEPLOYMENT_CAPACITY
@@ -52,10 +55,17 @@ pipeline:
       - OPENAI_API_KEY
       - OPENAI_ORGANIZATION
       - AZURE_USE_APPLICATION_INSIGHTS
+      - AZURE_APPLICATION_INSIGHTS
+      - AZURE_APPLICATION_INSIGHTS_DASHBOARD
+      - AZURE_LOG_ANALYTICS
       - USE_VECTORS
       - USE_GPT4V
       - AZURE_VISION_ENDPOINT
       - VISION_SECRET_NAME
+      - AZURE_COMPUTER_VISION_SERVICE
+      - AZURE_COMPUTER_VISION_RESOURCE_GROUP
+      - AZURE_COMPUTER_VISION_LOCATION
+      - AZURE_COMPUTER_VISION_SKU
       - AZURE_KEY_VAULT_NAME
       - AZURE_USE_AUTHENTICATION
       - AZURE_ENFORCE_ACCESS_CONTROL

docs/deploy_existing.md

@@ -1,21 +1,25 @@
 
 # Deploying with existing Azure resources
 
-If you already have existing Azure resources, you can re-use those by setting `azd` environment values.
+If you already have existing Azure resources, or if you want to specify the exact name of new Azure Resource, you can do so by setting `azd` environment values.
 You should set these values before running `azd up`. Once you've set them, return to the [deployment steps](../README.md#deploying).
 
-* [Existing resource group](#existing-resource-group)
-* [Existing OpenAI resource](#existing-openai-resource)
-* [Existing Azure AI Search resource](#existing-azure-ai-search-resource)
-* [Existing Azure Document Intelligence resource](#existing-azure-document-intelligence-resource)
-* [Other existing Azure resources](#other-existing-azure-resources)
+* [Resource group](#resource-group)
+* [OpenAI resource](#openai-resource)
+* [Azure AI Search resource](#azure-ai-search-resource)
+* [Azure App Service Plan and App Service resources](#azure-app-service-plan-and-app-service-resources)
+* [Azure Application Insights and related resources](#azure-application-insights-and-related-resources)
+* [Azure Computer Vision resources](#azure-computer-vision-resources)
+* [Azure Document Intelligence resource](#azure-document-intelligence-resource)
+* [Other Azure resources](#other-azure-resources)
 
-## Existing resource group
+
+## Resource group
 
 1. Run `azd env set AZURE_RESOURCE_GROUP {Name of existing resource group}`
 1. Run `azd env set AZURE_LOCATION {Location of existing resource group}`
 
-## Existing OpenAI resource
+## OpenAI resource
 
 ### Azure OpenAI:
 
@@ -40,7 +44,7 @@ Do *not* check your key into source control.
 When you run `azd up` after and are prompted to select a value for `openAiResourceGroupLocation`, you can select any location as it will not be used.
 
 
-## Existing Azure AI Search resource
+## Azure AI Search resource
 
 1. Run `azd env set AZURE_SEARCH_SERVICE {Name of existing Azure AI Search service}`
 1. Run `azd env set AZURE_SEARCH_SERVICE_RESOURCE_GROUP {Name of existing resource group with ACS service}`
@@ -55,7 +59,26 @@ You can also customize the search service (new or existing) for non-English sear
 1. To turn off the spell checker, run `azd env set AZURE_SEARCH_QUERY_SPELLER none`. Consult [this table](https://learn.microsoft.com/rest/api/searchservice/preview-api/search-documents#queryLanguage) to determine if spell checker is supported for your query language.
 1. To configure the name of the analyzer to use for a searchable text field to a value other than "en.microsoft", run `azd env set AZURE_SEARCH_ANALYZER_NAME {Name of analyzer name}`. ([See other possible values](https://learn.microsoft.com/dotnet/api/microsoft.azure.search.models.field.analyzer?view=azure-dotnet-legacy&viewFallbackFrom=azure-dotnet))
 
-## Existing Azure Document Intelligence resource
+## Azure App Service Plan and App Service resources
+
+1. Run `azd env set AZURE_APP_SERVICE_PLAN {Name of existing Azure App Service Plan}`
+1. Run `azd env set AZURE_APP_SERVICE {Name of existing Azure App Service}`.
+1. Run `azd env set AZURE_APP_SERVICE_SKU {SKU of Azure App Service, defaults to B1}`.
+
+## Azure Application Insights and related resources
+
+1. Run `azd env set AZURE_APPLICATION_INSIGHTS {Name of existing Azure App Insights}`.
+1. Run `azd env set AZURE_APPLICATION_INSIGHTS_DASHBOARD {Name of existing Azure App Insights Dashboard}`.
+1. Run `azd env set AZURE_LOG_ANALYTICS {Name of existing Azure Log Analytics Workspace Name}`.
+
+## Azure Computer Vision resources
+
+1. Run `azd env set AZURE_COMPUTER_VISION_SERVICE {Name of existing Azure Computer Vision Service Name}`
+1. Run `azd env set AZURE_COMPUTER_VISION_RESOURCE_GROUP {Name of existing Azure Computer Vision Resource Group Name}`
+1. Run `azd env set AZURE_COMPUTER_VISION_LOCATION {Name of existing Azure Computer Vision Location}`
+1. Run `azd env set AZURE_COMPUTER_VISION_SKU {SKU of Azure Computer Vision service, defaults to F0}`
+
+## Azure Document Intelligence resource
 
 In order to support analysis of many document formats, this repository uses a preview version of Azure Document Intelligence (formerly Form Recognizer) that is only available in [limited regions](https://learn.microsoft.com/azure/ai-services/document-intelligence/concept-layout).
 If your existing resource is in one of those regions, then you can re-use it by setting the following environment variables:
@@ -65,6 +88,6 @@ If your existing resource is in one of those regions, then you can re-use it by
 1. Run `azd env set AZURE_DOCUMENTINTELLIGENCE_RESOURCE_GROUP {Name of resource group with existing service, defaults to main resource group}`
 1. Run `azd env set AZURE_DOCUMENTINTELLIGENCE_SKU {SKU of existing service, defaults to S0}`
 
-## Other existing Azure resources
+## Other Azure resources
 
-You can also use existing Azure AI Document Intelligence and Storage Accounts. See `./infra/main.parameters.json` for list of environment variables to pass to `azd env set` to configure those existing resources.
+You can also use existing Azure AI Storage Accounts. See `./infra/main.parameters.json` for list of environment variables to pass to `azd env set` to configure those existing resources.

infra/main.bicep

@@ -9,17 +9,17 @@ param environmentName string
 @description('Primary location for all resources')
 param location string
 
-param appServicePlanName string = ''
-param backendServiceName string = ''
-param resourceGroupName string = ''
+param appServicePlanName string = '' // Set in main.parameters.json
+param backendServiceName string = '' // Set in main.parameters.json
+param resourceGroupName string = '' // Set in main.parameters.json
 
-param applicationInsightsDashboardName string = ''
-param applicationInsightsName string = ''
-param logAnalyticsName string = ''
+param applicationInsightsDashboardName string = '' // Set in main.parameters.json
+param applicationInsightsName string = '' // Set in main.parameters.json
+param logAnalyticsName string = '' // Set in main.parameters.json
 
-param searchServiceName string = ''
-param searchServiceResourceGroupName string = ''
-param searchServiceLocation string = ''
+param searchServiceName string = '' // Set in main.parameters.json
+param searchServiceResourceGroupName string = '' // Set in main.parameters.json
+param searchServiceLocation string = '' // Set in main.parameters.json
 // The free tier does not support managed identity (required) or semantic search (optional)
 @allowed([ 'free', 'basic', 'standard', 'standard2', 'standard3', 'storage_optimized_l1', 'storage_optimized_l2' ])
 param searchServiceSkuName string // Set in main.parameters.json
@@ -30,8 +30,8 @@ param searchServiceSemanticRankerLevel string // Set in main.parameters.json
 var actualSearchServiceSemanticRankerLevel = (searchServiceSkuName == 'free') ? 'disabled' : searchServiceSemanticRankerLevel
 param useSearchServiceKey bool = searchServiceSkuName == 'free'
 
-param storageAccountName string = ''
-param storageResourceGroupName string = ''
+param storageAccountName string = '' // Set in main.parameters.json
+param storageResourceGroupName string = '' // Set in main.parameters.json
 param storageResourceGroupLocation string = location
 param storageContainerName string = 'content'
 param storageSkuName string // Set in main.parameters.json
@@ -66,8 +66,9 @@ param openAiSkuName string = 'S0'
 param openAiApiKey string = ''
 param openAiApiOrganization string = ''
 
-param documentIntelligenceServiceName string = ''
-param documentIntelligenceResourceGroupName string = ''
+param documentIntelligenceServiceName string = '' // Set in main.parameters.json
+param documentIntelligenceResourceGroupName string = '' // Set in main.parameters.json
+
 // Limited regions for new version:
 // https://learn.microsoft.com/azure/ai-services/document-intelligence/concept-layout
 @description('Location for the Document Intelligence resource group')
@@ -79,12 +80,12 @@ param documentIntelligenceResourceGroupName string = ''
 })
 param documentIntelligenceResourceGroupLocation string
 
-param documentIntelligenceSkuName string = 'S0'
+param documentIntelligenceSkuName string // Set in main.parameters.json
 
-param computerVisionServiceName string = ''
-param computerVisionResourceGroupName string = ''
-param computerVisionResourceGroupLocation string = 'eastus' // Vision vectorize API is yet to be deployed globally
-param computerVisionSkuName string = 'S1'
+param computerVisionServiceName string = '' // Set in main.parameters.json
+param computerVisionResourceGroupName string = '' // Set in main.parameters.json
+param computerVisionResourceGroupLocation string = '' // Set in main.parameters.json
+param computerVisionSkuName string // Set in main.parameters.json
 
 param chatGptModelName string = ''
 param chatGptDeploymentName string = ''

infra/main.parameters.json

@@ -23,6 +23,18 @@
     "openAiSkuName": {
       "value": "S0"
     },
+    "computerVisionServiceName": {
+      "value": "${AZURE_COMPUTER_VISION_SERVICE}"
+    },
+    "computerVisionResourceGroupName": {
+      "value": "${AZURE_COMPUTER_VISION_RESOURCE_GROUP}"
+    },
+    "computerVisionResourceGroupLocation": {
+      "value": "${AZURE_COMPUTER_VISION_LOCATION=eastus}"
+    },
+    "computerVisionSkuName": {
+      "value": "${AZURE_COMPUTER_VISION_SKU=S1}"
+    },
     "documentIntelligenceServiceName": {
       "value": "${AZURE_DOCUMENTINTELLIGENCE_SERVICE}"
     },
@@ -68,9 +80,15 @@
     "storageSkuName": {
       "value": "${AZURE_STORAGE_SKU=Standard_LRS}"
     },
+    "appServicePlanName": {
+      "value": "${AZURE_APP_SERVICE_PLAN}"
+    },
     "appServiceSkuName": {
       "value": "${AZURE_APP_SERVICE_SKU=B1}"
     },
+    "backendServiceName": {
+      "value": "${AZURE_APP_SERVICE}"
+    },
     "chatGptModelName":{
       "value": "${AZURE_OPENAI_CHATGPT_MODEL}"
     },
@@ -113,6 +131,15 @@
     "useApplicationInsights": {
       "value": "${AZURE_USE_APPLICATION_INSIGHTS=true}"
     },
+    "applicationInsightsName": {
+      "value": "${AZURE_APPLICATION_INSIGHTS}"
+    },
+    "applicationInsightsDashboardName": {
+      "value": "${AZURE_APPLICATION_INSIGHTS_DASHBOARD}"
+    },
+    "logAnalyticsName": {
+      "value": "${AZURE_LOG_ANALYTICS}"
+    },
     "useVectors": {
       "value": "${USE_VECTORS=true}"
     },