Microsoft Azure VpnGateways API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector VpnGateways API
schemes:
- https
tags:
- name: VpnGateways
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}:
    patch:
      tags:
      - VpnGateways
      operationId: microsoftAzureVpngatewaysUpdatetags
      x-ms-examples:
        VpnGatewayUpdate:
          $ref: ./examples/VpnGatewayUpdateTags.json
      description: Updates virtual wan vpn gateway tags.
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The resource group name of the VpnGateway.
      - name: gatewayName
        in: path
        required: true
        type: string
        description: The name of the gateway.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - name: vpnGatewayParameters
        in: body
        required: true
        schema:
          $ref: ./network.json#/definitions/TagsObject
        description: Parameters supplied to update a virtual wan vpn gateway tags.
      responses:
        '200':
          description: Request successful. Returns the details of the updated gateway.
          schema:
            $ref: '#/definitions/VpnGateway'
        '202':
          description: Accepted and the operation will complete asynchronously.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/reset
  : post:
      tags:
      - VpnGateways
      operationId: microsoftAzureVpngatewaysReset
      description: Resets the primary of the vpn gateway in the specified resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The resource group name of the VpnGateway.
      - name: gatewayName
        in: path
        required: true
        type: string
        description: The name of the gateway.
      - name: ipConfigurationId
        in: query
        required: false
        type: string
        description: VpnGateway ipConfigurationId to specify the gateway instance.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Request successful. The operation reset the primary of the VpnGateway.
          schema:
            $ref: '#/definitions/VpnGateway'
        '202':
          description: Accepted and the operation will complete asynchronously.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        ResetVpnGateway:
          $ref: ./examples/VpnGatewayReset.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Reset
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/startpacketcapture
  : post:
      tags:
      - VpnGateways
      operationId: microsoftAzureVpngatewaysStartpacketcapture
      description: Starts packet capture on vpn gateway in the specified resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The resource group name of the VpnGateway.
      - name: gatewayName
        in: path
        required: true
        type: string
        description: The name of the gateway.
      - name: parameters
        in: body
        required: false
        schema:
          $ref: '#/definitions/VpnGatewayPacketCaptureStartParameters'
        description: Vpn gateway packet capture parameters supplied to start packet capture on vpn gateway.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Request successful. The operation packet capture started on vpn gateway.
          schema:
            type: string
        '202':
          description: Accepted and the operation will complete asynchronously.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        Start packet capture on vpn gateway without filter:
          $ref: ./examples/VpnGatewayStartPacketCapture.json
        Start packet capture on vpn gateway with filter:
          $ref: ./examples/VpnGatewayStartPacketCaptureFilterData.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Startpacketcapture
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/stoppacketcapture
  : post:
      tags:
      - VpnGateways
      operationId: microsoftAzureVpngatewaysStoppacketcapture
      description: Stops packet capture on vpn gateway in the specified resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The resource group name of the VpnGateway.
      - name: gatewayName
        in: path
        required: true
        type: string
        description: The name of the gateway.
      - name: parameters
        in: body
        required: false
        schema:
          $ref: '#/definitions/VpnGatewayPacketCaptureStopParameters'
        description: Vpn gateway packet capture parameters supplied to stop packet capture on vpn gateway.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Request successful. The operation packet capture stopped on vpn gateway.
          schema:
            type: string
        '202':
          description: Accepted and the operation will complete asynchronously.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        Stop packet capture on vpn gateway:
          $ref: ./examples/VpnGatewayStopPacketCapture.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Stoppacketcapture
definitions:
  VpnSiteLinkConnection:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/VpnSiteLinkConnectionProperties'
        description: Properties of the VPN site link connection.
      name:
        type: string
        description: The name of the resource that is unique within a resource group. This name can be used to access the resource.
      etag:
        type: string
        readOnly: true
        description: A unique read-only string that changes whenever the resource is updated.
      type:
        readOnly: true
        type: string
        description: Resource type.
    allOf:
    - $ref: ./network.json#/definitions/SubResource
    description: VpnSiteLinkConnection Resource.
  VpnGateway:
    required:
    - location
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/VpnGatewayProperties'
        description: Properties of the VPN gateway.
      etag:
        type: string
        readOnly: true
        description: A unique read-only string that changes whenever the resource is updated.
    allOf:
    - $ref: ./network.json#/definitions/Resource
    description: VpnGateway Resource.
  VpnGatewayNatRuleProperties:
    properties:
      provisioningState:
        readOnly: true
        $ref: ./network.json#/definitions/ProvisioningState
        description: The provisioning state of the NAT Rule resource.
      type:
        type: string
        description: The type of NAT rule for VPN NAT.
        enum:
        - Static
        - Dynamic
        x-ms-enum:
          name: VpnNatRuleType
          modelAsString: true
      mode:
        type: string
        description: The Source NAT direction of a VPN NAT.
        enum:
        - EgressSnat
        - IngressSnat
        x-ms-enum:
          name: VpnNatRuleMode
          modelAsString: true
      internalMappings:
        type: array
        items:
          $ref: '#/definitions/VpnNatRuleMapping'
        description: The private IP address internal mapping for NAT.
      externalMappings:
        type: array
        items:
          $ref: '#/definitions/VpnNatRuleMapping'
        description: The private IP address external mapping for NAT.
      ipConfigurationId:
        type: string
        description: The IP Configuration ID this NAT rule applies to.
      egressVpnSiteLinkConnections:
        type: array
        readOnly: true
        items:
          $ref: ./network.json#/definitions/SubResource
        description: List of egress VpnSiteLinkConnections.
      ingressVpnSiteLinkConnections:
        type: array
        readOnly: true
        items:
          $ref: ./network.json#/definitions/SubResource
        description: List of ingress VpnSiteLinkConnections.
    description: Parameters for VpnGatewayNatRule.
  VpnGatewayPacketCaptureStopParameters:
    properties:
      sasUrl:
        type: string
        description: SAS url for packet capture on vpn gateway.
    description: Stop packet capture parameters.
  PropagatedRouteTable:
    description: The list of RouteTables to advertise the routes to.
    properties:
      labels:
        type: array
        description: The list of labels.
        items:
          type: string
      ids:
        type: array
        description: The list of resource ids of all the RouteTables.
        items:
          $ref: ./network.json#/definitions/SubResource
  StaticRoutesConfig:
    description: Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection.
    type: object
    properties:
      propagateStaticRoutes:
        description: Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
        type: boolean
        readOnly: true
      vnetLocalRouteOverrideCriteria:
        description: Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
        $ref: '#/definitions/VnetLocalRouteOverrideCriteria'
  VpnGatewayProperties:
    properties:
      virtualHub:
        $ref: ./network.json#/definitions/SubResource
        description: The VirtualHub to which the gateway belongs.
      connections:
        type: array
        description: List of all vpn connections to the gateway.
        items:
          $ref: '#/definitions/VpnConnection'
      bgpSettings:
        $ref: ./virtualNetworkGateway.json#/definitions/BgpSettings
        description: Local network gateway's BGP speaker settings.
      provisioningState:
        readOnly: true
        $ref: ./network.json#/definitions/ProvisioningState
        description: The provisioning state of the VPN gateway resource.
      vpnGatewayScaleUnit:
        type: integer
        format: int32
        description: The scale unit for this vpn gateway.
      ipConfigurations:
        type: array
        readOnly: true
        description: List of all IPs configured on the gateway.
        items:
          $ref: '#/definitions/VpnGatewayIpConfiguration'
      enableBgpRouteTranslationForNat:
        type: boolean
        description: Enable BGP routes translation for NAT on this VpnGateway.
      isRoutingPreferenceInternet:
        type: boolean
        description: Enable Routing Preference property for the Public IP Interface of the VpnGateway.
      natRules:
        type: array
        description: List of all the nat Rules associated with the gateway.
        items:
          $ref: '#/definitions/VpnGatewayNatRule'
    description: Parameters for VpnGateway.
  RoutingConfiguration:
    description: Routing Configuration indicating the associated and propagated route tables for this connection.
    properties:
      associatedRouteTable:
        $ref: ./network.json#/definitions/SubResource
        description: The resource id RouteTable associated with this RoutingConfiguration.
      propagatedRouteTables:
        $ref: '#/definitions/PropagatedRouteTable'
        description: The list of RouteTables to advertise the routes to.
      vnetRoutes:
        $ref: '#/definitions/VnetRoute'
        description: List of routes that control routing from VirtualHub into a virtual network connection.
      inboundRouteMap:
        $ref: ./network.json#/definitions/SubResource
        description: The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
      outboundRouteMap:
        $ref: ./network.json#/definitions/SubResource
        description: The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
  VpnGatewayPacketCaptureStartParameters:
    properties:
      filterData:
        type: string
        description: Start Packet capture parameters on vpn gateway.
    description: Start packet capture parameters.
  VnetRoute:
    description: List of routes that control routing from VirtualHub into a virtual network connection.
    properties:
      staticRoutesConfig:
        $ref: '#/definitions/StaticRoutesConfig'
        description: Configuration for static routes on this HubVnetConnection.
      staticRoutes:
        type: array
        description: List of all Static Routes.
        items:
          $ref: '#/definitions/StaticRoute'
      bgpConnections:
        type: array
        readOnly: true
        description: The list of references to HubBgpConnection objects.
        items:
          $ref: ./network.json#/definitions/SubResource
  VpnGatewayNatRule:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/VpnGatewayNatRuleProperties'
        description: Properties of the VpnGateway NAT rule.
      name:
        type: string
        description: The name of the resource that is unique within a resource group. This name can be used to access the resource.
      etag:
        type: string
        readOnly: true
        description: A unique read-only string that changes whenever the resource is updated.
      type:
        readOnly: true
        type: string
        description: Resource type.
    allOf:
    - $ref: ./network.json#/definitions/SubResource
    description: VpnGatewayNatRule Resource.
  VpnSiteLinkConnectionProperties:
    properties:
      vpnSiteLink:
        $ref: ./network.json#/definitions/SubResource
        description: Id of the connected vpn site link.
      routingWeight:
        type: integer
        format: int32
        description: Routing weight for vpn connection.
      vpnLinkConnectionMode:
        type: string
        description: Vpn link connection mode.
        enum:
        - Default
        - ResponderOnly
        - InitiatorOnly
        x-ms-enum:
          name: VpnLinkConnectionMode
          modelAsString: true
      connectionStatus:
        description: The connection status.
        $ref: '#/definitions/VpnConnectionStatus'
      vpnConnectionProtocolType:
        description: Connection protocol used for this connection.
        $ref: ./virtualNetworkGateway.json#/definitions/ConnectionProtocol
      ingressBytesTransferred:
        type: integer
        format: int64
        readOnly: true
        description: Ingress bytes transferred.
      egressBytesTransferred:
        type: integer
        format: int64
        readOnly: true
        description: Egress bytes transferred.
      connectionBandwidth:
        type: integer
        format: int32
        description: Expected bandwidth in MBPS.
      sharedKey:
        type: string
        description: SharedKey for the vpn connection.
      enableBgp:
        type: boolean
        description: EnableBgp flag.
      vpnGatewayCustomBgpAddresses:
        type: array
        items:
          $ref: ./virtualNetworkGateway.json#/definitions/GatewayCustomBgpIpAddressIpConfiguration
        description: vpnGatewayCustomBgpAddresses used by this connection.
        x-ms-identifiers: []
      usePolicyBasedTrafficSelectors:
        type: boolean
        description: Enable policy-based traffic selectors.
      ipsecPolicies:
        type: array
        items:
          $ref: ./virtualNetworkGateway.json#/definitions/IpsecPolicy
        description: The IPSec Policies to be considered by this connection.
      enableRateLimiting:
        type: boolean
        description: EnableBgp flag.
      useLocalAzureIpAddress:
        type: boolean
        description: Use local azure ip to initiate connection.
      provisioningState:
        readOnly: true
        $ref: ./network.json#/definitions/ProvisioningState
        description: The provisioning state of the VPN site link connection resource.
      ingressNatRules:
        type: array
        items:
          $ref: ./network.json#/definitions/SubResource
        description: List of ingress NatRules.
      egressNatRules:
        type: array
        items:
          $ref: ./network.json#/definitions/SubResource
        description: List of egress NatRules.
      dpdTimeoutSeconds:
        type: integer
        format: int32
        description: Dead Peer Detection timeout in seconds for VpnLink connection.
    description: Parameters for VpnConnection.
  VnetLocalRouteOverrideCriteria:
    type: string
    description: Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke vnet.
    enum:
    - Contains
    - Equal
    x-ms-enum:
      name: VnetLocalRouteOverrideCriteria
      modelAsString: true
  StaticRoute:
    description: List of all Static Routes.
    properties:
      name:
        type: string
        description: The name of the StaticRoute that is unique within a VnetRoute.
      addressPrefixes:
        type: array
        description: List of all address prefixes.
        items:
          type: string
      nextHopIpAddress:
        type: string
        description: The ip address of the next hop.
  VpnConnection:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/VpnConnectionProperties'
        description: Properties of the VPN connection.
      name:
        type: string
        description: The name of the resource that is unique within a resource group. This name can be used to access the resource.
      etag:
        type: string
        readOnly: true
        description: A unique read-only string that changes whenever the resource is updated.
    allOf:
    - $ref: ./network.json#/definitions/SubResource
    description: VpnConnection Resource.
  VpnGatewayIpConfiguration:
    description: IP Configuration of a VPN Gateway Resource.
    properties:
      id:
        type: string
        description: The identifier of the IP configuration for a VPN Gateway.
      publicIpAddress:
        type: string
        description: The public IP address of this IP configuration.
      privateIpAddress:
        type: string
        description: The private IP address of this IP configuration.
  VpnConnectionProperties:
    properties:
      remoteVpnSite:
        $ref: ./network.json#/definitions/SubResource
        description: Id of the connected vpn site.
      routingWeight:
        type: integer
        format: int32
        description: Routing weight for vpn connection.
      dpdTimeoutSeconds:
        type: integer
        format: int32
        description: DPD timeout in seconds for vpn connection.
      connectionStatus:
        description: The connection status.
        $ref: '#/definitions/VpnConnectionStatus'
      vpnConnectionProtocolType:
        description: Connection protocol used for this connection.
        $ref: ./virtualNetworkGateway.json#/definitions/ConnectionProtocol
      ingressBytesTransferred:
        type: integer
        format: int64
        readOnly: true
        description: Ingress bytes transferred.
      egressBytesTransferred:
        type: integer
        format: int64
        readOnly: true
        description: Egress bytes transferred.
      connectionBandwidth:
        type: integer
        format: int32
        description: Expected bandwidth in MBPS.
      sharedKey:
        type: string
        description: SharedKey for the vpn connection.
      enableBgp:
        type: boolean
        description: EnableBgp flag.
      usePolicyBasedTrafficSelectors:
        type: boolean
        description: Enable policy-based traffic selectors.
      ipsecPolicies:
        type: array
        items:
          $ref: ./virtualNetworkGateway.json#/definitions/IpsecPolicy
        description: The IPSec Policies to be considered by this connection.
      trafficSelectorPolicies:
        type: array
        items:
          $ref: ./virtualNetworkGateway.json#/definitions/TrafficSelectorPolicy
        description: The Traffic Selector Policies to be considered by this connection.
      enableRateLimiting:
        type: boolean
        description: EnableBgp flag.
      enableInternetSecurity:
        type: boolean
        description: Enable internet security.
      useLocalAzureIpAddress:
        type: boolean
        description: Use local azure ip to initiate connection.
      provisioningState:
        readOnly: true
        $ref: ./network.json#/definitions/ProvisioningState
        description: The provisioning state of the VPN connection resource.
      vpnLinkConnections:
        type: array
        description: List of all vpn site link connections to the gateway.
        items:
          $ref: '#/definitions/VpnSiteLinkConnection'
      routingConfiguration:
        $ref: '#/definitions/RoutingConfiguration'
        description: The Routing Configuration indicating the associated and propagated route tables on this connection.
    description: Parameters for VpnConnection.
  VpnNatRuleMapping:
    properties:
      addressSpace:
        type: string
        description: Address space for Vpn NatRule mapping.
      portRange:
        type: string
        description: Port range for Vpn NatRule mapping.
    description: Vpn NatRule mapping.
  VpnConnectionStatus:
    type: string
    description: The current state of the vpn connection.
    readOnly: true
    enum:
    - Unknown
    - Connecting
    - Connected
    - NotConnected
    x-ms-enum:
      name: VpnConnectionStatus
      modelAsString: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'