Preparing to Deploy Ops Manager on Azure

Step 1: Install and Configure the Azure CLI
Step 2: Set Your Default Subscription
Step 3: Create an AAD Application
Step 4: Create and Configure a Service Principal
Step 5: Verify Your Service Principal
Step 6: Perform Registrations
Next Steps

Page last updated:

This topic describes how to prepare Azure to deploy VMware Tanzu Operations Manager (Ops Manager). You must deploy Ops Manager to deploy VMware Tanzu Application Service for VMs (TAS for VMs) or VMware Tanzu Kubernetes Grid Integrated Edition (TKGI).

Step 1: Install and Configure the Azure CLI

Install the Azure CLI 2.0 by following the instructions for your operating system in Install the Azure CLI in the Microsoft Azure documentation.
On the command line, set your cloud with a name value by running the following command:
```
az cloud set --name CLOUD-NAME
```
Where CLOUD-NAME is one of the following values. Use the value that corresponds to the Azure environment on which you are installing Ops Manager:
- Azure: AzureCloud.
- Azure China: AzureChinaCloud. If logging in to AzureChinaCloud fails with a CERT_UNTRUSTED, use the latest version of node, 4.x or later. For more information about this error, see Failed to login AzureChinaCloud in the Azure/azure-xplat-cli GitHub repository.
- Azure Government Cloud: AzureUSGovernment.
- Azure Germany: AzureGermanCloud.
For example:
```
$ az cloud set --name AzureCloud
```
To log in, run the following command:
```
az login
```
Authenticate by navigating to the URL in the output from the command, entering the provided code, and clicking your account.

Step 2: Set Your Default Subscription

To list your Azure subscriptions, run the following command:

az account list

For example:

$ az account list
[
 {
  "id": "12345678-1234-5678-1234-567891234567",
  "name": "Sample Subscription",
  "user": {
    "name": "Sample Account",
    "type": "user"
 },
  "tenantId": "11111111-1234-5678-1234-678912345678",
  "state": "Enabled",
  "isDefault": true,
  "registeredProviders": [],
  "environmentName": "AzureCloud"
},
{
  "id": "87654321-1234-5678-1234-678912345678",
  "name": "Sample Subscription1",
  "user": {
    "name": "Sample Account1",
    "type": "user"
 },
  "tenantId": "22222222-1234-5678-1234-678912345678",
  "state": "Enabled",
  "isDefault": false,
  "registeredProviders": [],
  "environmentName": "AzureCloud"
 }
]

Identify your default subscription in the output of this command by locating the subscription listed that has isDefault set to true. To deploy Ops Manager to a different subscription, you must set the other subscription as the default. To set a new default subscription, run the following command:
```
az account set --subscription SUBSCRIPTION-ID
```
Where SUBSCRIPTION-ID is the value of the id field of the subscription that you want to set as the default.

The following example sets the default to a subscription that has an id with the value of "87654321-1234-5678-1234-567891234567".
```
$ az account set --subscription "87654321-1234-5678-1234-567891234567"
```
Record the value of the id of the default subscription. You use this value in future configuration steps.
Record the value of tenantID of the default subscription. This is your TENANT_ID for creating a service principal. If your tenantID value is not defined, you may be using a personal account to log in to your Azure subscription.

Step 3: Create an AAD Application

To create an Azure Active Directory (AAD) application, run the following command:
```
az ad app create --display-name "Service Principal for BOSH" \
--password "PASSWORD" --homepage "http://BOSHAzureCPI" \
--identifier-uris "http://BOSHAzureCPI"
```
Where PASSWORD is a password of your choice. This is your CLIENT_SECRET for creating a service principal.

For example:
```
$ az ad app create --display-name "Service Principal for BOSH" \
--password "Swordfish" --homepage "http://BOSHAzureCPI" \
--identifier-uris "http://BOSHAzureCPI"
```
Note: You can provide any string for the homepage and identifier-uris flags, but the value of identifer-uris must be unique within the organization associated with your Azure subscription. For the homepage, VMware recommends using http://BOSHAzureCPI as shown in the example above.

From the output of the az ad app create that you ran in the previous step, locate and record the value of appId. This is your APPLICATION_ID for creating a service principal.

The following example output shows "5c552e8f-b977-45f5-a50b-981cfe17cb9d" as the value of appId.

{
  "appId": "5c552e8f-b977-45f5-a50b-981cfe17cb9d",
  "appPermissions": null,
  "availableToOtherTenants": false,
  "displayName": "Service Principal for BOSH",
  "homepage": "http://BOSHAzureCIP",
  "identifierUris": [
    "http://BOSHAzureCPI"
  ],
  "objectId": "f3884df4-7d1d-4894-a78c-c1fe75750436",
  "objectType": "Application",
  "replyUrls": []
}

Step 4: Create and Configure a Service Principal

To create a service principal, run the following command:

az ad sp create --id YOUR-APPLICATION-ID

Where YOUR-APPLICATION-ID is the APPLICATION_ID that you recorded in Create an AAD Application.

For example:

$ az ad sp create --id 5c552e8f-b977-45f5-a50b-981cfe17cb9d
{
  "appId": "5c552e8f-b977-45f5-a50b-981cfe17cb9d",
  "displayName": "Service Principal for BOSH",
  "objectId": "cc13c685-4c3b-461e-ae96-7a0563960b83",
  "objectType": "ServicePrincipal",
  "servicePrincipalNames": [
    "5c552e8f-b977-45f5-a50b-981cfe17cb9d",
    "http://BOSHAzureCPI"
  ]
}

You must have the Owner role on your service principal to deploy Ops Manager to Azure. To assign the Owner role on your service principal, run the following command:
```
az role assignment create --assignee "SERVICE-PRINCIPAL-NAME" \
--role "Owner" --scope /subscriptions/SUBSCRIPTION-ID
```
Where:
- SERVICE-PRINCIPAL-NAME is any value of servicePrincipalNames from the output above, such as YOUR-APPLICATION-ID.
- SUBSCRIPTION-ID is the value of the id of the default subscription that you recorded in Set Your Default Subscription.
For example:
```
$ az role assignment create \
--assignee "5c552e8f-b977-45f5-a50b-981cfe17cb9d" \
--role "Owner" \
--scope /subscriptions/87654321-1234-5678-1234-567891234567
```
Note: If you need to use multiple resource groups for your deployment on Azure, you can define custom roles for your Service Principal. These roles allow BOSH to deploy to pre-existing network resources outside of the resource group.

For more information about Azure Role-Based Access Control, refer to Built-in roles for Azure resource the Microsoft Azure documentation.

To verify the role assignment, run the following command:

az role assignment list --assignee "SERVICE-PRINCIPAL-NAME"

Where "SERVICE-PRINCIPAL-NAME" is any value of servicePrincipalNames from the output above, such as YOUR-APPLICATION-ID.

For example:

$ az role assignment list --assignee "5c552e8f-b977-45f5-a50b-981cfe17cb9d"
[
  {
    "id": "/subscriptions/995b7eed-77ef-45ff-a5c9-1a405ffb8243/providers/Microsoft.Authorization/roleAssignments/32e644cf-ba1a-4f43-bf7c-68bf4583e463",
    "name": "32e644cf-ba1a-4f43-bf7c-68bf4583e463",
    "properties": {
      "principalId": "cc13c685-4c3b-461e-ae96-7a0563960b83",
      "principalName": "http://BOSHAzureCPI",
      "roleDefinitionId": "/subscriptions/995b7eed-77ef-45ff-a5c9-1a405ffb8243/providers/Microsoft.Authorization/roleDefinitions/b24988ac-6180-42a0-ab88-20f7382dd24c",
      "roleDefinitionName": "Owner",
      "scope": "/subscriptions/995b7eed-77ef-45ff-a5c9-1a405ffb8243"
    },
    "type": "Microsoft.Authorization/roleAssignments"
  }
]

Step 5: Verify Your Service Principal

To verify your service principal, run the following command to log in to your service principal:

az login --username APPLICATION_ID --password CLIENT_SECRET \
--service-principal --tenant TENANT_ID

Where:

APPLICATION_ID is the APPLICATION_ID that you recorded in Create an AAD Application.
CLIENT_SECRET is the password that you provided in Create an AAD Application.
TENANT_ID is the value of tenantID of the default subscription that you recorded in Set Your Default Subscription.

For example:

$ az login --username 5c552e8f-b977-45f5-a50b-981cfe17cb9d \
--password "Swordfish" \
--service-principal --tenant 22222222-1234-5678-1234-678912345678
[
  {
    "cloudName": "AzureCloud",
    "id": "995b7eed-77ef-45ff-a5c9-1a405ffb8243",
    "isDefault": true,
    "name": "my-user-name",
    "state": "Enabled",
    "tenantId": "22222222-1234-5678-1234-678912345678",
    "user": {
      "name": "5c552e8f-b977-45f5-a50b-981cfe17cb9d",
      "type": "servicePrincipal"
    }
  }
]

If you cannot log in, the service principal is invalid. Create a new service principal and try again.

Step 6: Perform Registrations

To register your subscription with Microsoft.Storage, run the following command:
```
az provider register --namespace Microsoft.Storage
```
To register your subscription with Microsoft.Network, run the following command:
```
az provider register --namespace Microsoft.Network
```
To register your subscription with Microsoft.Compute, run the following command:
```
az provider register --namespace Microsoft.Compute
```

Next Steps

After you complete this procedure, follow the instructions in Deploying Ops Manager on Azure.

Create a pull request or raise an issue on the source for this page in GitHub