mongocli atlas networking peering azure create

Prerequisites

You must complete the following steps before you create each Azure network peering connection:

1. Run the following Azure CLI command to create a service principal using the specified Atlas peering application ID:

   az ad sp create --id e90a1407-55c3-432d-9cb1-3638900a9d22

   You only have to do this once for each subscription. If you receive the following message, the service principal with the Atlas peering application ID already exists. Proceed to the next step.

   Another object with the same value for property servicePrincipalNames already exists.

2. Copy the following example peering-role.json file and save it to your current working directory:

   1
   {
   2
     "Name":"AtlasPeering/<azureSubscriptionId>/<resourceGroupName>/<vnetName>",
   3
     "IsCustom":true,
   4
     "Description":"Grants MongoDB access to manage peering connections on network /subscriptions/<azureSubscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Network/virtualNetworks/<vnetName>",
   5
     "Actions":[
   6
         "Microsoft.Network/virtualNetworks/virtualNetworkPeerings/read",
   7
         "Microsoft.Network/virtualNetworks/virtualNetworkPeerings/write",
   8
         "Microsoft.Network/virtualNetworks/virtualNetworkPeerings/delete",
   9
         "Microsoft.Network/virtualNetworks/peer/action"
   10
     ],
   11
     "AssignableScopes":[
   12
         "/subscriptions/<azureSubscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Network/virtualNetworks/<vnetName>"
   13
     ]
   14
   }

3. Replace the variables in the peering-role.json with details about the Azure VNet to which you want to create a peering connection:

   Variable	Description
   azureSubscriptionId	Unique identifer of the Azure subscription in which the VNet resides.
   resourceGroupName	Name of your Azure resource group.
   vnetName	Name of your Azure VNet.

4. Run the following Azure CLI command to create the role definition using the peering-role.json file:

   az role definition create --role-definition peering-role.json

5. Run the Azure CLI command shown below to assign the role you created to the service principal.

   Replace the variables with the same values you used in the peering-role.json file.

   az role assignment create  \
   --role "AtlasPeering/<azureSubscriptionId>/<resourceGroupName>/<vnetName>" \
   --assignee "e90a1407-55c3-432d-9cb1-3638900a9d22" \
   --scope "/subscriptions/<azureSubscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Network/virtualNetworks/<vnetName>"

Syntax

mongocli atlas networking peering azure create
     [ --atlasCidrBlock <atlas-cidr-block> ]
     --directoryId <azure-ad-tenant-id>
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]
     [ --projectId <project-ID> ]
     --region <azure-region-id>
     --resourceGroup <azure-resource-group-name>
     --subscriptionId <azure-subscription-id>
     --vnet <azure-vnet-name>

Options

Output

If the command succeeds, it returns the following output in the default format. If the command returns errors, see Troubleshooting for recommended solutions.

Network peering connection '<peering-connection-id>' created.

The default output is a subset of the fields returned by this command. For the complete list of JSON fields returned by the command, see the Public API reference for your MongoDB service:

• Atlas API

Example

mongocli atlas networking peering create azure --atlasCidrBlock 192.168.0.0/21 \
--directoryId 56657fdb-ca45-40dc-fr56-77fd8b6d2b37 \
--subscriptionId 345654f3-77cf-4084-9e06-8943a079ed75 \
--resourceGroup mongocli-test --region US_EAST_2 --vnet mongocli-test

Network peering connection '5f621a5669a49208c2160f40' created.

mongocli atlas networking peering create azure --atlasCidrBlock 192.168.0.0/21 \
--directoryId 56657fdb-ca45-40dc-fr56-77fd8b6d2b37 \
--subscriptionId 345654f3-77cf-4084-9e06-8943a079ed75 \
--resourceGroup mongocli-test --region US_EAST_2 --vnet mongocli-test \
--output json

{
  "containerId": "5f3a84b1242d9c2dc7cf244a",
  "id": "5f621a5669a49208c2160f40",
  "azureDirectoryId": "56657fdb-ca45-40dc-fr56-77fd8b6d2b37",
  "azureSubscriptionId": "345654f3-77cf-4084-9e06-8943a079ed75",
  "resourceGroupName": "mongocli-test",
  "vnetName": "mongocli-test",
  "status": "ADDING_PEER"
}