KeyAcquisitionScript.md

Script to acquire cognitive services keys required for the Kiosk application using azure cli commands from bash / git bash

Create resource group

# Create resource group, replace resouce group name and location of resource group as required
az group create -n kiosk-cog-service-keys -l westus2

Generate keys and echo the keys

Please note! jq needs to be installed to execute the commands below. If you do not want to use jq then you can just execute the az group deployment command and then search in the outputs section of the json where you will find the keys.

To get the keys with the default parameters execute the following commands

# The command below creates the cognitive service keys required by the KIOSK app, and then prints the keys
echo $(az deployment group create -n cog-keys-deploy -g kiosk-cog-service-keys --template-uri https://raw.githubusercontent.com/Microsoft/Cognitive-Samples-IntelligentKiosk/master/Kiosk/cognitive-keys-azure-deploy.json) | jq '.properties.outputs'

# If you dont have jq installed you can execute the command, and manually search for the outputs section
# az deployment group create -n cog-keys-deploy -g kiosk-cog-service-keys --template-uri https://raw.githubusercontent.com/Microsoft/Cognitive-Samples-IntelligentKiosk/master/Kiosk/cognitive-keys-azure-deploy.json

If instead you want to modify the default parameters you need to get the cognitive-keys-azure-deploy.json and cognitive-keys-azure-deploy.parameters.json files locally and execute the following commands

# Change working directory to Kiosk
cd Kiosk
  
# The command below creates the cognitive service keys required by the KIOSK app, and then prints the keys. You can modifiy the tiers associated with the generated keys by modifying the parameter values
echo $(az deployment group create -n cog-keys-deploy -g kiosk-cog-service-keys --template-file cognitive-keys-azure-deploy.json --parameters @cognitive-keys-azure-deploy.parameters.json) | jq '.properties.outputs'

# If you dont have jq installed you can execute the command, and manually search for the outputs section
# az deployment group create -n cog-keys-deploy -g kiosk-cog-service-keys --template-file cognitive-keys-azure-deploy.json --parameters @cognitive-keys-azure-deploy.parameters.json
    

Sample output of above commands is as follows:

# Sample output of above command
{
    "anomalyDetectorEndpoint": {
        "type": "String",
        "value": "https://westus2.api.cognitive.microsoft.com/"
    },
    "anomalyDetectorKey1": {
        "type": "String",
        "value": "5c9**************************************"
    },
    "bingSearchKey1": {
        "type": "String",
        "value": "88*********************************"
    },
    "compVisionEndpoint": {
        "type": "String",
        "value": "https://westus2.api.cognitive.microsoft.com/"
    },
    "compVisionKey1": {
        "type": "String",
        "value": "fa5**************************************"
    },
    "customVisionPredictionEndpoint": {
        "type": "String",
        "value": "https://westus2.api.cognitive.microsoft.com/"
    },
    "customVisionPredictionKey1": {
        "type": "String",
        "value": "fbd**************************************"
    },
    "customVisionTrainingEndpoint": {
        "type": "String",
        "value": "https://westus2.api.cognitive.microsoft.com/"
    },
    "customVisionTrainingKey1": {
        "type": "String",
        "value": "b36**************************************"
    },
    "customVisionTrainingResourceId": {
        "type": "String",
        "value": "/subscriptions/420**********/resourceGroups/ki********/providers/Microsoft.CognitiveServices/accounts/*******"
    },
    "faceEndpoint": {
        "type": "String",
        "value": "https://westus2.api.cognitive.microsoft.com/"
    },
    "faceKey1": {
        "type": "String",
        "value": "87f7****************************************"
    },
    "formRecognizerEndpoint": {
        "type": "String",
        "value": "https://westus2.api.cognitive.microsoft.com/"
    },
    "formRecognizerKey1": {
        "type": "String",
        "value": "2d3**************************************"
    },
    "speechEndpoint": {
        "type": "String",
        "value": "https://westus2.api.cognitive.microsoft.com/sts/v1.0/issuetoken"
    },
    "speechKey1": {
        "type": "String",
        "value": "e1c**************************************"
    },
    "textAnalyticsEndpoint": {
        "type": "String",
        "value": "https://westus2.api.cognitive.microsoft.com/"
    },
    "textAnalyticsKey1": {
        "type": "String",
        "value": "ba3*************************************"
    },
    "textTranslatorEndpoint": {
        "type": "String",
        "value": "https://api.cognitive.microsofttranslator.com/"
    },
    "textTranslatorKey1": {
        "type": "String",
        "value": "551*************************************"
    }
}