Instaclustr Logo
Powered by Redocly

Azure Vnet Peer V2

Operations related to Azure Vnet Peering with Cluster Data Centers.

List all Azure VNet Peering requests

SecurityBasic Authentication
Responses
200

Successfully retrieved Azure VNet Peering requests.

get/cluster-management/v2/data-sources/providers/azure/vnet-peers/v2
Request samples 
curl -i -X GET \
  -u <username>:<password> \
  https://api.instaclustr.com/cluster-management/v2/data-sources/providers/azure/vnet-peers/v2
Response samples
application/json
[
  • {
    }
]

Create Azure Vnet Peering Request

SecurityBasic Authentication
Request
Request Body schema: application/json
required
peerVirtualNetworkName
required
string

The name of the VPC Network you wish to peer to.

peerSubnets
required
Array of strings

The subnets for the peering VPC.

peerResourceGroup
required
string

Resource Group Name of the Virtual Network.

peerAdObjectId
string

ID of the Active Directory Object to give peering permissions to, required for cross subscription peering.

peerSubscriptionId
required
string

Subscription ID of the Virtual Network.

cdcId
required
string <uuid>

ID of the Cluster Data Centre.

Responses
202

Azure Vnet Peering request created.

post/cluster-management/v2/resources/providers/azure/vnet-peers/v2
Request samples
application/json
{
  • "cdcId": "f3eab841-6952-430d-ba90-1bfc3f15da10",
  • "peerAdObjectId": "00000000-0000-0000-0000-000000000000",
  • "peerResourceGroup": "example-resource-group-123",
  • "peerSubnets": [
    ],
  • "peerSubscriptionId": "00000000-0000-0000-0000-000000000000",
  • "peerVirtualNetworkName": "network-aabb-1122"
}
Response samples
application/json
{
  • "cdcId": "f3eab841-6952-430d-ba90-1bfc3f15da10",
  • "peerAdObjectId": "00000000-0000-0000-0000-000000000000",
  • "peerResourceGroup": "example-resource-group-123",
  • "peerSubnets": [
    ],
  • "peerSubscriptionId": "00000000-0000-0000-0000-000000000000",
  • "peerVirtualNetworkName": "network-aabb-1122"
}

Get Azure Vnet Peering Connection info

Fetches the details for a given Azure Vnet Peering Connection.

SecurityBasic Authentication
Request
path Parameters
vpcPeerId
required
string <uuid>

ID of the VPC Peering Connection

Responses
200

Azure Vnet Peering Connection info retrieved.

404

VPC Peering Connection not found.

get/cluster-management/v2/resources/providers/azure/vnet-peers/v2/{vpcPeerId}
Request samples 
curl -i -X GET \
  -u <username>:<password> \
  'https://api.instaclustr.com/cluster-management/v2/resources/providers/azure/vnet-peers/v2/{vpcPeerId}'
Response samples
application/json
{
  • "cdcId": "f3eab841-6952-430d-ba90-1bfc3f15da10",
  • "peerAdObjectId": "00000000-0000-0000-0000-000000000000",
  • "peerResourceGroup": "example-resource-group-123",
  • "peerSubnets": [
    ],
  • "peerSubscriptionId": "00000000-0000-0000-0000-000000000000",
  • "peerVirtualNetworkName": "network-aabb-1122"
}

Delete Azure Vnet Peering Connection

SecurityBasic Authentication
Request
path Parameters
vpcPeerId
required
string <uuid>

ID of the VPC Peering Connection

Responses
204

Azure Vnet Peering request deleted

404

VPC Peering Connection not found.

delete/cluster-management/v2/resources/providers/azure/vnet-peers/v2/{vpcPeerId}
Request samples 
curl -i -X DELETE \
  -u <username>:<password> \
  'https://api.instaclustr.com/cluster-management/v2/resources/providers/azure/vnet-peers/v2/{vpcPeerId}'
Response samples
application/json
{
  • "errors": [
    ]
}
➔ Next to Cadence Provisioning V2