CREATE ENCRYPTED AZURE CREDENTIAL FILE

Summary

Create Encrypted Azure Credential File creates an encrypted password-protected file that stores Microsoft Azure Batch and Storage account credential information for use with the other tools in the Land Spill Azure toolset.

To learn more about the Liquids HCA Tool in general, please see Liquids HCA Tool Frequently Asked Questions.

To learn more about the structure of the Liquids HCA Tool project geodatabase, please see Liquids HCA Tool Data Dictionary.

Usage

Microsoft Azure^® is a commercial cloud computing platform upon which the Liquids HCA Tool performs Land Spill GeoClaw overland flow simulations for your release points.

To run GeoClaw simulations on Azure, you must have an Azure portal account with access to an Azure Batch account properly configured to run GeoClaw and an associated Azure Storage account. To learn more about creating an Azure Batch account, see the Azure help topic, Create a Batch account with the Azure portal. To learn more about configuring an Azure Batch account for use with GeoClaw, see the Gas HCA Tool help topic, Configure Azure.

Create Encrypted Azure Credential File expects the following parameters (the required Azure account parameters may be found in the Keys section of your Azure Batch account properties):

Azure Batch Account Name – Your Azure Batch account name.
Azure Batch Account Key – The primary or secondary access key for your Azure Batch account.
Azure Batch Account URL – The URL for your Azure Batch account.
Azure Storage Account Name – The name of the Azure Storage account associated with your Azure Batch account.
Azure Storage Account Key – Key1 or Key2 for the Azure Storage account associated with your Azure Batch account.
Passcode and Confirm Passcode – This is your own passcode for the encrypted Azure credential file. The encrypted Azure credential file can only be unencrypted for use when you supply this You should apply the same security measures for safeguarding this passcode that you apply to your Windows password.
Output Credential File Directory – This is the directory location in which your encrypted Azure credential file is stored. By default, this is the scratch folder for your active ArcGIS Pro project.
Output Credential File Name – The default name of your encrypted Azure credential file is azure_cred.bin. However, this parameter allows you to specify an alternate name, if desired.

You typically perform Create Encrypted Azure Credential File before running any of the other Land Spill Azure toolset tools that require access to Azure. Although an encrypted Azure credential file is not required to use these tools, it saves time by obviating the need to separately supply your Azure Batch and Storage account particulars each time you run a tool requiring access to Azure.

For visual reference on Liquids HCA Tool execution order, see Liquids HCA Tool Process Flow Diagrams.

Syntax

CreateAzureCredentialFile (azure_batch_name, azure_batch_key, azure_batch_URL, azure_storage_name, azure_storage_key, passcode, confirm_passcode, working_dir, output_file)

Parameter	Explanation	Data Type
azure_batch_name	Dialog Reference Specify the name of the Azure Batch account. There is no Python reference for this parameter.	String
azure_batch_key	Dialog Reference Specify the Azure Batch account key. There is no Python reference for this parameter.	String
azure_batch_URL	Dialog Reference Specify the Azure Batch account URL. There is no Python reference for this parameter.	String
azure_storage_name	Dialog Reference Specify the Azure Storage account name. There is no Python reference for this parameter.	String
azure_storage_key	Dialog Reference Specify the Azure Storage account key. There is no Python reference for this parameter.	String
passcode	Dialog Reference Specify the passcode for the credential file. There is no Python reference for this parameter.	String Hidden
confirm_passcode	Dialog Reference Confirm the passcode for the credential file. There is no Python reference for this parameter.	String Hidden
working_dir	Dialog Reference Specify the directory path to your output encrypted Azure credential file. There is no Python reference for this parameter.	Workspace
output_file	Dialog Reference Specify the name of the output encrypted Azure credential file. There is no Python reference for this parameter.	String

Code sample

The following script demonstrates how to use Create Encrypted Azure Credential File with azure batch account credentials:

import arcpy

arcpy.ImportToolbox(r”C:\Program Files\ArcGIS\Pro\bin\Python\envs\arcgispro-py3\Lib\site-packages\liquidshca\esri\toolboxes\LiquidsHCA.pyt”)

batch_account = “azure_batch”

batch_key = “jhkhhAHHK###%hsfkds”

batch_url = “https://test123.batch.azure.com”

storage_account = “azure_storage”

storage_key = “dfdasfdFDS$%^$–==”

passcode = “xxxxxxx”

in_dir = r”C:\test”

file_name = “azure_cred.bin”

arcpy.liquidshca.CreateAzureCredentialFile(batch_account, batch_key, batch_url, storage_account, storage_key, passcode, passcode in_dir, file_name)

Environments

Scratch Workspace

Licensing information

This tool requires a valid Liquids HCA Tool user license or subscription. Please see the Request License and Register License tool help topics for details on obtaining and registering a Gas HCA Tool software license.

Credits

geoclaw-azure-launcher:

Use limitations

There are no access and use limitations for this item.