Skip to content

Latest commit

 

History

History
370 lines (284 loc) · 14.6 KB

azure_vpn_gateway.md

File metadata and controls

370 lines (284 loc) · 14.6 KB
Raw

Document: "virtualWan"

Path: "https://github.com/Azure/azure-rest-api-specs/blob/2fbb5118cd34f412a51d9bc8a274224b216763cf/specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/virtualWan.json")

VpnGateway

VpnGateway Resource.

azure_vpn_gateway {
  api_version => "api_version",
  gateway_name => "gateway_name",
  id => "id (optional)",
  location => "location (optional)",
  properties => $azure_vpn_gateway_properties
  resource_group_name => "resource_group_name",
  subscription_id => "subscription_id",
  tags => "tags (optional)",
  vpn_gateway_parameters => "vpnGatewayParameters",
}
Name Type Required Description
api_version String true Client API version.
gateway_name String true The name of the gateway.
id String false Resource ID.
location String false Resource location.
properties VpnGatewayProperties false Properties of the VPN gateway.
resource_group_name String true The resource group name of the VpnGateway.
subscription_id String true The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
tags Hash false Resource tags.
vpn_gateway_parameters Hash true Parameters supplied to create or Update a virtual wan vpn gateway.

VpnGatewayProperties

Parameters for VpnGateway.

$azure_vpn_gateway_properties = {
  bgpSettings => $azure_bgp_settings
  connections => $azure_vpn_connection
  provisioningState => $azure_provisioning_state
  virtualHub => $azure_sub_resource
  vpnGatewayScaleUnit => "1234 (optional)",
}
Name Type Required Description
bgpSettings BgpSettings false Local network gateway's BGP speaker settings.
connections VpnConnection false List of all vpn connections to the gateway.
provisioningState ProvisioningState false The provisioning state of the resource.
virtualHub SubResource false The VirtualHub to which the gateway belongs.
vpnGatewayScaleUnit Integer false The scale unit for this vpn gateway.

BgpSettings

BGP settings details.

$azure_bgp_settings = {
  asn => "1234 (optional)",
  bgpPeeringAddress => "bgpPeeringAddress (optional)",
  peerWeight => "1234 (optional)",
}
Name Type Required Description
asn Integer false The BGP speaker's ASN.
bgpPeeringAddress String false The BGP peering address and BGP identifier of this BGP speaker.
peerWeight Integer false The weight added to routes learned from this BGP speaker.

VpnConnection

VpnConnection Resource.

$azure_vpn_connection = {
  api-version => "api-version",
  connectionName => "connectionName",
  gatewayName => "gatewayName",
  id => "id (optional)",
  name => "name (optional)",
  properties => $azure_vpn_connection_properties
  resourceGroupName => "resourceGroupName",
  subscriptionId => "subscriptionId",
  VpnConnectionParameters => "VpnConnectionParameters",
}
Name Type Required Description
api-version String true Client API version.
connectionName String true The name of the connection.
gatewayName String true The name of the gateway.
id String false Resource ID.
name String false The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties VpnConnectionProperties false Properties of the VPN connection.
resourceGroupName String true The resource group name of the VpnGateway.
subscriptionId String true The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
VpnConnectionParameters Hash true Parameters supplied to create or Update a VPN Connection.

VpnConnectionProperties

Parameters for VpnConnection.

$azure_vpn_connection_properties = {
  connectionBandwidth => "1234 (optional)",
  connectionStatus => $azure_vpn_connection_status
  enableBgp => "enableBgp (optional)",
  enableInternetSecurity => "enableInternetSecurity (optional)",
  enableRateLimiting => "enableRateLimiting (optional)",
  ipsecPolicies => $azure_ipsec_policy
  provisioningState => $azure_provisioning_state
  remoteVpnSite => $azure_sub_resource
  routingWeight => "1234 (optional)",
  sharedKey => "sharedKey (optional)",
  useLocalAzureIpAddress => "useLocalAzureIpAddress (optional)",
  usePolicyBasedTrafficSelectors => "usePolicyBasedTrafficSelectors (optional)",
  vpnConnectionProtocolType => $azure_connection_protocol
  vpnLinkConnections => $azure_vpn_site_link_connection
}
Name Type Required Description
connectionBandwidth Integer false Expected bandwidth in MBPS.
connectionStatus VpnConnectionStatus false The connection status.
enableBgp Boolean false EnableBgp flag.
enableInternetSecurity Boolean false Enable internet security.
enableRateLimiting Boolean false EnableBgp flag.
ipsecPolicies IpsecPolicy false The IPSec Policies to be considered by this connection.
provisioningState ProvisioningState false The provisioning state of the resource.
remoteVpnSite SubResource false Id of the connected vpn site.
routingWeight Integer false Routing weight for vpn connection.
sharedKey String false SharedKey for the vpn connection.
useLocalAzureIpAddress Boolean false Use local azure ip to initiate connection.
usePolicyBasedTrafficSelectors Boolean false Enable policy-based traffic selectors.
vpnConnectionProtocolType ConnectionProtocol false Connection protocol used for this connection.
vpnLinkConnections VpnSiteLinkConnection false List of all vpn site link connections to the gateway.

VpnConnectionStatus

The current state of the vpn connection.

$azure_vpn_connection_status = {
}
Name Type Required Description

IpsecPolicy

An IPSec Policy configuration for a virtual network gateway connection.

$azure_ipsec_policy = {
  dhGroup => $azure_dh_group
  ikeEncryption => $azure_ike_encryption
  ikeIntegrity => $azure_ike_integrity
  ipsecEncryption => $azure_ipsec_encryption
  ipsecIntegrity => $azure_ipsec_integrity
  pfsGroup => $azure_pfs_group
  saDataSizeKilobytes => "1234",
  saLifeTimeSeconds => "1234",
}
Name Type Required Description
dhGroup DhGroup true The DH Group used in IKE Phase 1 for initial SA.
ikeEncryption IkeEncryption true The IKE encryption algorithm (IKE phase 2).
ikeIntegrity IkeIntegrity true The IKE integrity algorithm (IKE phase 2).
ipsecEncryption IpsecEncryption true The IPSec encryption algorithm (IKE phase 1).
ipsecIntegrity IpsecIntegrity true The IPSec integrity algorithm (IKE phase 1).
pfsGroup PfsGroup true The Pfs Group used in IKE Phase 2 for new child SA.
saDataSizeKilobytes Integer true The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
saLifeTimeSeconds Integer true The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.

DhGroup

The DH Groups used in IKE Phase 1 for initial SA.

$azure_dh_group = {
}
Name Type Required Description

IkeEncryption

The IKE encryption algorithm (IKE phase 2).

$azure_ike_encryption = {
}
Name Type Required Description

IkeIntegrity

The IKE integrity algorithm (IKE phase 2).

$azure_ike_integrity = {
}
Name Type Required Description

IpsecEncryption

The IPSec encryption algorithm (IKE phase 1).

$azure_ipsec_encryption = {
}
Name Type Required Description

IpsecIntegrity

The IPSec integrity algorithm (IKE phase 1).

$azure_ipsec_integrity = {
}
Name Type Required Description

PfsGroup

The Pfs Groups used in IKE Phase 2 for new child SA.

$azure_pfs_group = {
}
Name Type Required Description

ProvisioningState

The current provisioning state.

$azure_provisioning_state = {
}
Name Type Required Description

SubResource

Reference to another subresource.

$azure_sub_resource = {
  id => "id (optional)",
}
Name Type Required Description
id String false Resource ID.

ConnectionProtocol

Gateway connection protocol.

$azure_connection_protocol = {
}
Name Type Required Description

VpnSiteLinkConnection

VpnSiteLinkConnection Resource.

$azure_vpn_site_link_connection = {
  id => "id (optional)",
  name => "name (optional)",
  properties => $azure_vpn_site_link_connection_properties
}
Name Type Required Description
id String false Resource ID.
name String false The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties VpnSiteLinkConnectionProperties false Properties of the VPN site link connection.

VpnSiteLinkConnectionProperties

Parameters for VpnConnection.

$azure_vpn_site_link_connection_properties = {
  connectionBandwidth => "1234 (optional)",
  connectionStatus => $azure_vpn_connection_status
  enableBgp => "enableBgp (optional)",
  enableRateLimiting => "enableRateLimiting (optional)",
  ipsecPolicies => $azure_ipsec_policy
  provisioningState => $azure_provisioning_state
  routingWeight => "1234 (optional)",
  sharedKey => "sharedKey (optional)",
  useLocalAzureIpAddress => "useLocalAzureIpAddress (optional)",
  usePolicyBasedTrafficSelectors => "usePolicyBasedTrafficSelectors (optional)",
  vpnConnectionProtocolType => $azure_connection_protocol
  vpnSiteLink => $azure_sub_resource
}
Name Type Required Description
connectionBandwidth Integer false Expected bandwidth in MBPS.
connectionStatus VpnConnectionStatus false The connection status.
enableBgp Boolean false EnableBgp flag.
enableRateLimiting Boolean false EnableBgp flag.
ipsecPolicies IpsecPolicy false The IPSec Policies to be considered by this connection.
provisioningState ProvisioningState false The provisioning state of the resource.
routingWeight Integer false Routing weight for vpn connection.
sharedKey String false SharedKey for the vpn connection.
useLocalAzureIpAddress Boolean false Use local azure ip to initiate connection.
usePolicyBasedTrafficSelectors Boolean false Enable policy-based traffic selectors.
vpnConnectionProtocolType ConnectionProtocol false Connection protocol used for this connection.
vpnSiteLink SubResource false Id of the connected vpn site link.

CRUD operations

Here is a list of endpoints that we use to create, read, update and delete the VpnGateway

Operation Path Verb Description OperationID
Create /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Network/vpnGateways/%{gateway_name} Put Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway. VpnGateways_CreateOrUpdate
List - list all /subscriptions/%{subscription_id}/providers/Microsoft.Network/vpnGateways Get Lists all the VpnGateways in a subscription. VpnGateways_List
List - get one /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Network/vpnGateways/%{gateway_name} Get Retrieves the details of a virtual wan vpn gateway. VpnGateways_Get
List - get list using params /subscriptions/%{subscription_id}/providers/Microsoft.Network/vpnGateways Get Lists all the VpnGateways in a subscription. VpnGateways_List
Update /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Network/vpnGateways/%{gateway_name} Put Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway. VpnGateways_CreateOrUpdate
Delete /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.Network/vpnGateways/%{gateway_name} Delete Deletes a virtual wan vpn gateway. VpnGateways_Delete