In order to register your Azure account with Frame, ensure that you have the met the following requirements before proceeding:
Microsoft Azure account with a valid Azure subscription
Permissions to add and modify role assignments for the Azure Subscription ID.
The Azure subscription has the following Resource Providers registered.
Costs (e.g., storage) may begin to accrue immediately after completing the registration of your Azure account on your Frame Customer or Organization entity.
Before your Azure account can be registered with Frame, you will need to complete two tasks:
- Create an Azure application registration
- Add Azure subscription owner permissions to your Azure application registration
Create an Azure Application Registration
You will need to create an Azure app registration for Frame. The app registration is the mechanism by which you'll give Frame access to create and manage network, virtual machines, and storage resources in your Azure subscription.
Open the Azure Active Directory option and App registration section. From there, select “New registration” to create a new app.
You'll see a panel titled “Register an application.” You'll be asked for the following information:
- Name: you can choose any name. Some customers simply use the name "Frame". Others will append some identifying information for internal reporting purposes to "Frame". This name will appear in the list of Application Registrations.
- Supported account types: Specify who has access to the application. "Accounts in this organization directory only" is the standard selection for customers.
- Redirect URI (Optional): This value can be left blank.
Click “Register” at the bottom of the "Register an Application" page.
A notification will appear informing you that your application has been created successfully. It should now be available in your “App registrations” list.
Next, select your new application from the list and copy or write down the values for the “Application (client) ID” and “Directory (tenant) ID.” These IDs are two of the four values you will need for setting up your Frame integration (note that you do NOT need the “Object ID”).
Once you have written down the Application (client) ID, navigate to the “Branding” page listed in the menu on the left side of your Azure portal.
Download the application icon shown below and upload the Frame logo file to Azure by clicking on the folder browser icon to the right of Upload new logo and selecting the Frame logo file you downloaded. Click “Save” to save the Frame logo for your App Registration.
Next, you'll need to create a “Client Secret” for Frame to use as a password to manage your Azure resources. Click “Certificates & secrets” under your application's management options. Click the “New client secret” button under “Client secrets”.
You will be prompted to add a new client secret. Simply add a description and select the desired expiration duration from the drop-down menu next to “Expires.” Click “Add.”
On the “Client secrets” page, copy your newly-created client secret. Your client secret can only be copied right after the secret is created. You will need this value when you add your Azure subscription to Frame.caution
The client secret is used by Frame to manage your BYO Azure account. Microsoft Azure has a maximum expiration date of 2 years from the client secret creation date. If you fail to update your client secret before it expires, Frame will no longer be able to manage the resources in your Azure account and you will likely experience a service outage.
Before your client secret expires, you will need to generate a new client secret (following Steps 9 and 10 above) and re-enter your cloud account secret in the Configuration tab of your Azure Cloud Account.
Configuring your Azure Subscription
This section assumes that you already have an active Azure account with a subscription wthat can be used for Frame workloads. At this point, you should have also set the resource limits for your subscription to levels high enough to accommodate your expected loads. To confirm your subscription status, login to the Azure web portal, navigate to your subscription, and confirm that its status is “active”:
Before registering your Azure account with Frame, you will grant owner permissions to your new Azure App Registration.
At the top of your Azure portal, search for “Subscriptions” and click on the first option that appears.
Find the subscription that you will use with Frame. Copy the Subscription ID and set it aside to be used in the final steps of this guide.
Now, click on the subscription to open its properties. Click on the "Access Control (IAM)" page, and then click the "Add" button on the top of the Access Control panel. Select "Add role assignment."
A new window will appear asking for the following information:
- Role: Use “Owner” or “Contributor” from the drop-down menu.
- Assign access to: Select “Azure AD user, group, or service principal” option.
- Select: Select the name of your application.
Once you have configured the fields above, click "Save."
Before moving on, ensure you have obtained the following values.
- Azure Application ID
- Azure Directory ID
- Azure Subscription ID
- Azure Client Secret
You will use these values for the Frame setup below.
Adding your Cloud Acount
Go to your Frame Admin Console.
Navigate to the Customer or the Organization page (depending on where you wish to add the cloud account).
Click on Cloud Accounts in the left-hand menu.
Click the Add Cloud Account button on the top-right corner of the page.
A new window will appear prompting you for the following information:
- Cloud provider: Select Azure.
- Name: Enter the desired name of your cloud service. This will be the name of the Cloud Account in Frame Console.
- Directory ID: Enter the Azure Directory ID.
- Subscription ID: Enter the Azure Subscription ID.
- Application ID: Enter the Azure Application ID.
- Secret: Enter the Azure Secret key value.
- Azure Hybrid Use Benefit: Enable if your Microsoft Azure Agreement entitles you to have Azure Hybrid Use Benefit.
Once you have entered the information, click the “Verify credentials” button.
Once your credentials are verified, you can select the data centers (Azure regions) for your Frame accounts. You may add additional data centers in the future.
Check the box at the bottom informing you of possible resource usage on your Azure cloud infrastructure and then click "Add Account". After a few minutes, you will see your Azure Cloud Account listed as "Ready".
Now that your Azure Cloud Account is created and accessible within Frame, you will be able to create Frame accounts using this BYO cloud account. Be aware that the first Frame account created in an Azure datacenter region may take 30+ minutes as Frame Platform must copy the Nutanix-provided OS images to the Azure datacenter before the Frame account is created.
Resources Created During BYO Azure Cloud Account Creation
Frame provisions a single storage account for every datacenter region selected upon cloud account creation. The Frame-provided OS master images (Windows 10, Windows Server 2016, Windows Server 2019, Ubuntu 20.04, etc.) are copied to each storage account and will be used when the first Frame account is created in that region.
By default, a newly created Azure account will impose certain service limits on available resources. Depending on the number of the Frame workload VMs required of a given machine family (e.g., number of concurrent users on NV6), how the Frame account is created (e.g., Frame networking with or without an SGA), and whether you use Publish or Quick Publish, you will likely need to adjust the default limits imposed by Microsoft on the Azure account. If these limits are set to values that are lower than what is required by the Frame platform, you can expect certain functions to either fail, or be substantially delayed. The requirements by Frame for these service limits depends on the desired workload and required resources. The recommended service limit increases include the following:
|Virtual Machines-Family vCPUs (CPU-only and GPU instance types)||Azure has quotas on the total number of vCPUs and the total number of family-specific vCPUs, on a per-location basis. We recommend you first determine the expected max number of instances by instance type (per Frame account) for your needs. Next, calculate the number of vCPUs and family-specific vCPUs based on the expected max number of instances and the required number of vCPUs per instance type (for that family). If you use Publish, set your vCPU quota to 2.2 times the required number of vCPUs and specific family-specific vCPUs quotas to 2.2 times your expected max number of instances. The additional 20% will accommodate any additional resources such as Sandboxes, Utility servers, etc. If you use Quick Publish, you can use a minimum factor of 1.X times to calculate the required number of vCPUs and family-specific vCPUs. X is computed as the “Number of production instances created on publish” divided by expected max instances. By default, the “Number of production instances created on publish” value is configured to be 10 VMs. A factor of 1.3-1.5 should be sufficient to account for typical Quick Publishes and overhead.|
|Azure Managed Disks||Typically, this resource quota does not need to be modified. To estimate total disk storage consumption, multiply the total number of VMs you expect to provision by the size of the Sandbox VM (e.g., Windows 10 images 128 GiB; Windows Server images 64 GiB) across all Frame accounts you plan to provision. Number and size of any utility servers, number of Sandbox image backups, number and size of personal drives, and number and size of enterprise profile disks would be additional storage to consider.|
|Public IPs||You will need 1 public IP address for each powered on VM for Frame accounts created with Frame networking (default). You will also need to account for the temporary increase of public IP addresses during a Publish or Quick Publish when the new production VMs are created and before the old production VMs are terminated. If the Frame account is created using Frame networking, private network with Streaming Gateway Appliance (SGA), then you will need 1 public IP address for the SGA VM (or the load balancer in front of the SGA VMs) and all of the workload VMs will only have private IP addresses.|
|VNets||If Frame networking (default) or Frame networking (private networking) is used to create Frame accounts, the number of VNets equals the number of Frame accounts. If Frame networking (private networking with SGA) is used to create Frame accounts, the required number of VNets is two times the number of Frame accounts. For BYO networking, no new networks are created.|
Service limit increases may not be necessary for smaller production environments or trial accounts.
Each IaaS provider has a unique naming scheme for their instance types. Azure names their instance types based on the "virtual machine type" Microsoft has created for specific workload use cases. More information about virtual machine types can be found in Microsoft's official documentation.
For the latest Azure instances supported by Frame, refer to Frame Pricing Page.
Promotional instances provided by Microsoft by default are not supported by Frame. If you wish to use an account with an existing promotion, you will need to either exhaust promotional hours first or contact Azure support to remove those instances.