Create One New Network Peering Connection¶

Azure 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>"

Resource¶

POST /groups/{GROUP-ID}/peers

Response Elements¶

Example Request¶

1
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2
 --header "Accept: application/json" \
3
 --header "Content-Type: application/json" \
4
 --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/peers?pretty=true" \
5
 --data '
6
   {
7
     "accepterRegionName" : "us-west-1",
8
     "awsAccountId" : "abc123abc123",
9
     "containerId" : "{CONTAINER-ID}",
10
     "providerName" : "AWS",
11
     "routeTableCidrBlock" : "192.168.0.0/24",
12
     "vpcId" : "vpc-abc123abc123"
13
   }'

Example Response¶

1
{
2
  "accepterRegionName" : "us-west-1",
3
  "awsAccountId" : "999900000000",
4
  "connectionId" : null,
5
  "containerId" : "{CONTAINER-ID}",
6
  "errorStateName" : null,
7
  "id" : "{PEERING-CONNECTION-ID}",
8
  "routeTableCidrBlock" : "10.15.0.0/16",
9
  "statusName" : "INITIATING",
10
  "vpcId" : "vpc-abc123abc123"
11
}