CAUTION: The examples below are intended to be serve as general guidelines. Your platform or software version may differ, resulting in variations in images, screens, options, or other elements.
The Azure instance types in the az create commands in the procedure below use the instance types listed below:
Keep in mind that these are example instance types that meet the requirements stated in the Virtual Appliance Sizing Specifications section. You can select other instance types with the necessary vCPUs and RAM to perform your expected workload, as stated in the system requirements.
To prepare for the installation:
Current Azure Sensor Versions
The current sensor versions for Azure deployments are as follows:
You must authorize the Stellar Cyber software images so that they are available in the Azure portal:
Your Microsoft Entra Overview page appears.
The Properties page appears.
https://login.microsoftonline.com/<tenant id>/oauth2/authorize?client_id=58238038-43b4-4446-8260-0fa97ace1085&response_type=code&redirect_uri=https%3A%2F%2Fwww.microsoft.com%2F
The Permissions requested message appears.
The Enterprise applications | All applications page appears.
If you don't see any Stellar Cyber applications, contact Stellar Cyber support.
The Resource groups page appears.
The group details appear.
The Access control (IAM) page appears.
The Resource providers page appears.
A PowerShell windows opens and connects.
az account clear
az login --service-principal -u '58238038-43b4-4446-8260-0fa97ace1085' -p '3238Q~KMtVAIyuC6gDVMhboKEW7w6W~bXYQhFcZx' --tenant '2f580e30-1cc1-4c08-9e80-704999508e1a'
az account get-access-token
Make sure you use your Tenant ID, copied from your Azure Portal, as described in this step.
az login --service-principal -u '58238038-43b4-4446-8260-0fa97ace1085' -p '3238Q~KMtVAIyuC6gDVMhboKEW7w6W~bXYQhFcZx' --tenant '<Tenant ID>'
az account get-access-token
PS /home/j> az account list --output table
Name CloudName SubscriptionId State IsDefault
Pay-As-You-Go AzureCloud xxxxxxxx-f477-4f2d-94bc-35c00d3d5fd8 Enabled False
Subscription-Dev AzureCloud xxxxxxxx-ac50-4d82-a6ea-a14db86f3957 Enabled True
Subscription-QA AzureCloud xxxxxxxx-9114-4cb0-a044-7e01f074575c Enabled False
In this example, Subscription-Dev has IsDefault set to True and is where the deployment will take place. You can change the default subscription with the az account set --subscription <subscription> command. Let's change the default subscription to Subscription-QA:
PS /home/j> az account set --subscription xxxxxxxx-9114-4cb0-a044-7e01f074575c
PS /home/j> az account list --output table
Name CloudName SubscriptionId State IsDefault
Pay-As-You-Go AzureCloud xxxxxxxx-f477-4f2d-94bc-35c00d3d5fd8 Enabled False
Subscription-Dev AzureCloud xxxxxxxx-ac50-4d82-a6ea-a14db86f3957 Enabled False
Subscription-QA AzureCloud xxxxxxxx-9114-4cb0-a044-7e01f074575c Enabled True
After changing the default subscription, the sensor will now be deployed in Subscription-QA.
This command points to the most recent sensor image. You can install different versions by changing the version number in the command below.
Keep in mind that these commands use an instance type that meets the system requirements, including SSD storage. You can specify a different instance type with sufficient vCPUs and RAM to handle your expected workload while making sure to observe all system requirements.
Note that any resources you specify in the az vm create command must already exist in the same resource group where you are creating the VM. This includes any values you supply for the resource-group, vnet-name, subnet, subnet-address-prefix, and nsg arguments.
You can also use variables to pass values for the parameters in the az vm create command. Refer to Using Shell Variables to Create the Sensor VM for details.
Enter the following command to create a modular sensor VM. Replace <resource-group> with an existing resource group in your deployment and <version> with the version of software you want to install (for example, 5.3.0:
az vm create --size Standard_B12ms --resource-group <resource-group> --name StellarModularSensor --image "/subscriptions/0e28f851-f477-4f2d-94bc-35c00d3d5fd8/resourceGroups/Stellar/providers/Microsoft.Compute/galleries/StellarCyberSoftwares/images/Stellar-ModularSensor/versions/<version>" --admin-username azureuser --admin-password P@ssw0rd#2022 --storage-sku StandardSSD_LRS --os-disk-size-gb 128
Note that you can optionally specify the virtual network, subnet, and network security group to be used by the VM by including the --vnet-name, --subnet, and --nsg arguments. The resources you specify must exist in the same resource group where you are creating the VM. For example, for a modular sensor:
az vm create --size Standard_B12ms --resource-group <resource-group> --name StellarModularSensor --nsg <network-security-group> --vnet-name <vnet-name> --subnet <subnet-name> --subnet-address-prefix <subnet-cidr> --image "/subscriptions/0e28f851-f477-4f2d-94bc-35c00d3d5fd8/resourceGroups/Stellar/providers/Microsoft.Compute/galleries/StellarCyberSoftwares/images/Stellar-ModularSensor/versions/<version>" --admin-username azureuser --admin-password P@ssw0rd#2022 --storage-sku StandardSSD_LRS --os-disk-size-gb 128
You can also install the sensor without a public IP address by including the --public-ip address "" argument. For example, here's the same command from above with the --public-ip address "" argument included:
az vm create --size Standard_B12ms --resource-group <resource-group> --name StellarModularSensor --nsg <network-security-group> --vnet-name <vnet-name> --subnet <subnet-name> --subnet-address-prefix <subnet-cidr> --public-ip address "" --image "/subscriptions/0e28f851-f477-4f2d-94bc-35c00d3d5fd8/resourceGroups/Stellar/providers/Microsoft.Compute/galleries/StellarCyberSoftwares/images/Stellar-ModularSensor/versions/<version>" --admin-username azureuser --admin-password P@ssw0rd#2022 --storage-sku StandardSSD_LRS --os-disk-size-gb 128
Enter the following command for a modular sensor:
az network nsg rule create -g <resource-group> --nsg-name <NSG NAME> -n StellarPort1 --direction Inbound --protocol Udp --destination-port-ranges 8472 --priority 500
The az vm create commands in the examples above all specify values for parameters directly in the command. As an alternative, you can also declare shell variables for parameters you commonly reuse and include them in the az vm create command as part of a script.
The same rules for parameters included in an az vm create command also apply when passing variables in a script:
The example below starts by defining values for many of the parameters in the az vm create command before reading them in as part of the command:
#PowerShell script
#Assign values to variables
$RESOURCE_GROUP="<MyResourceGroup>"
$VM_NAME="<MyVM>"
$VNET_NAME="<MyVNet>"
$SUBNET_NAME="<MySubnet>"
$SUBNET_PREFIX=”<x.x.x.x/x>”
$NSG_NAME=””<MyNSG>”
$IMAGE=”/subscriptions/0e28f851-f477-4f2d-94bc-35c00d3d5fd8/resourceGroups/Stellar/providers/Microsoft.Compute/galleries/StellarCyberSoftwares/images/Stellar-ModularSensor/versions/<version>”
$ADMIN_USERNAME="azureuser"
$ADMIN_PASSWORD="P@ssw0rd#2022"
#Create Modular Sensor VM using variable values
az vm create --size Standard_B12ms --resource-group $RESOURCE_GROUP --name $VM_NAME --vnet-name $VNET_NAME --subnet $SUBNET_NAME --subnet-address-prefix $SUBNET_PREFIX --nsg $NSG_NAME --image $IMAGE --admin-username $ADMIN_USERNAME --admin-password $ADMIN_PASSWORD --storage-sku StandardSSD_LRS --os-disk-size-gb 128
Refer to this article on Microsoft Learn for more information on using variables in the Azure CLI.
To connect the sensor to the Stellar Cyber Platform:
Once complete, please reply to your engineer’s email with the following information so we can confirm that we are seeing the sensor and authorize it.
Sensor Details