swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector P2SVpnGateways API
schemes:
- https
tags:
- name: P2SVpnGateways
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}
  : patch:
      tags:
      - P2SVpnGateways
      operationId: microsoftAzureP2svpngatewaysUpdatetags
      x-ms-examples:
        P2SVpnGatewayUpdate:
          $ref: ./examples/P2SVpnGatewayUpdateTags.json
      description: Updates virtual wan p2s vpn gateway tags.
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The resource group name of the P2SVpnGateway.
      - name: gatewayName
        in: path
        required: true
        type: string
        description: The name of the gateway.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - name: p2SVpnGatewayParameters
        in: body
        required: true
        schema:
          $ref: ./network.json#/definitions/TagsObject
        description: Parameters supplied to update a virtual wan p2s vpn gateway tags.
      responses:
        '200':
          description: Request successful. Returns the details of the updated gateway.
          schema:
            $ref: '#/definitions/P2SVpnGateway'
        '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 P2svpngateways Gatewayname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/reset
  : post:
      tags:
      - P2SVpnGateways
      operationId: microsoftAzureP2svpngatewaysReset
      description: Resets the primary of the p2s vpn gateway in the specified resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The resource group name of the P2SVpnGateway.
      - name: gatewayName
        in: path
        required: true
        type: string
        description: The name of the gateway.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Request successful. The operation reset the primary of the P2SVpnGateway.
          schema:
            $ref: '#/definitions/P2SVpnGateway'
        '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:
        ResetP2SVpnGateway:
          $ref: ./examples/P2SVpnGatewayReset.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 P2svpngateways Gatewayname Reset
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/generatevpnprofile
  : post:
      tags:
      - P2SVpnGateways
      operationId: microsoftAzureP2svpngatewaysGeneratevpnprofile
      description: Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: gatewayName
        in: path
        required: true
        type: string
        description: The name of the P2SVpnGateway.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/P2SVpnProfileParameters'
        description: Parameters supplied to the generate P2SVpnGateway VPN client package operation.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: VPN profile package URL.
          schema:
            $ref: '#/definitions/VpnProfileResponse'
        '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:
        GenerateP2SVpnGatewayVPNProfile:
          $ref: ./examples/P2SVpnGatewayGenerateVpnProfile.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 P2svpngateways Gatewayname Generatevpnprofile
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealth
  : post:
      tags:
      - P2SVpnGateways
      operationId: microsoftAzureP2svpngatewaysGetp2svpnconnectionhealth
      description: Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: gatewayName
        in: path
        required: true
        type: string
        description: The name of the P2SVpnGateway.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: P2S Vpn Gateway with P2S connection health details.
          schema:
            $ref: '#/definitions/P2SVpnGateway'
        '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:
        P2SVpnGatewayGetConnectionHealth:
          $ref: ./examples/P2SVpnGatewayGetConnectionHealth.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 P2svpngateways Gatewayname Getp2svpnconnectionhealth
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealthDetailed
  : post:
      tags:
      - P2SVpnGateways
      operationId: microsoftAzureP2svpngatewaysGetp2svpnconnectionhealthdetailed
      description: Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: gatewayName
        in: path
        required: true
        type: string
        description: The name of the P2SVpnGateway.
      - name: request
        in: body
        required: true
        schema:
          $ref: '#/definitions/P2SVpnConnectionHealthRequest'
        description: Request parameters supplied to get p2s vpn connections detailed health.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: P2S connections detailed health report.
          schema:
            $ref: '#/definitions/P2SVpnConnectionHealth'
        '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:
        P2SVpnGatewayGetConnectionHealthDetailed:
          $ref: ./examples/P2SVpnGatewayGetConnectionHealthDetailed.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 P2svpngateways Gatewayname Getp2svpnconnectionhealthdetailed
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{p2sVpnGatewayName}/disconnectP2sVpnConnections
  : post:
      tags:
      - P2SVpnGateways
      operationId: microsoftAzureP2svpngatewaysDisconnectp2svpnconnections
      description: Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: p2sVpnGatewayName
        in: path
        required: true
        type: string
        description: The name of the P2S Vpn Gateway.
      - name: request
        in: body
        required: true
        schema:
          $ref: '#/definitions/P2SVpnConnectionRequest'
        description: The parameters are supplied to disconnect p2s vpn connections.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Request successful. The operation disconnects the requested vpn connections.
        '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:
        Disconnect VpnConnections from P2sVpn Gateway:
          $ref: ./examples/P2sVpnGatewaysDisconnectP2sVpnConnections.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 P2svpngateways P2svpngatewayname Disconnectp2svpnconnections
definitions:
  VpnServerConfigurationPolicyGroupProperties:
    type: object
    properties:
      isDefault:
        type: boolean
        description: Shows if this is a Default VpnServerConfigurationPolicyGroup or not.
      priority:
        type: integer
        format: int32
        description: Priority for VpnServerConfigurationPolicyGroup.
      policyMembers:
        type: array
        items:
          $ref: '#/definitions/VpnServerConfigurationPolicyGroupMember'
        description: Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.
        x-ms-identifiers: []
      p2SConnectionConfigurations:
        type: array
        readOnly: true
        items:
          $ref: ./network.json#/definitions/SubResource
        description: List of references to P2SConnectionConfigurations.
      provisioningState:
        readOnly: true
        $ref: ./network.json#/definitions/ProvisioningState
        description: The provisioning state of the VpnServerConfigurationPolicyGroup resource.
    description: Parameters for VpnServerConfigurationPolicyGroup.
  VpnProfileResponse:
    properties:
      profileUrl:
        type: string
        description: URL to the VPN profile.
    description: Vpn Profile Response for package generation.
  VpnClientConnectionHealth:
    properties:
      totalIngressBytesTransferred:
        readOnly: true
        type: integer
        format: int64
        description: Total of the Ingress Bytes Transferred in this P2S Vpn connection.
      totalEgressBytesTransferred:
        readOnly: true
        type: integer
        format: int64
        description: Total of the Egress Bytes Transferred in this connection.
      vpnClientConnectionsCount:
        type: integer
        format: int32
        description: The total of p2s vpn clients connected at this time to this P2SVpnGateway.
      allocatedIpAddresses:
        type: array
        items:
          type: string
        description: List of allocated ip addresses to the connected p2s vpn clients.
    description: VpnClientConnectionHealth properties.
  VpnServerConfigurationPolicyGroup:
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/VpnServerConfigurationPolicyGroupProperties'
        description: Properties of the VpnServerConfigurationPolicyGroup.
      etag:
        type: string
        readOnly: true
        description: A unique read-only string that changes whenever the resource is updated.
      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.
      type:
        readOnly: true
        type: string
        description: Resource type.
    allOf:
    - $ref: ./network.json#/definitions/SubResource
    description: VpnServerConfigurationPolicyGroup Resource.
  P2SConnectionConfigurationProperties:
    properties:
      vpnClientAddressPool:
        $ref: ./virtualNetwork.json#/definitions/AddressSpace
        description: The reference to the address space resource which represents Address space for P2S VpnClient.
      routingConfiguration:
        $ref: '#/definitions/RoutingConfiguration'
        description: The Routing Configuration indicating the associated and propagated route tables on this connection.
      enableInternetSecurity:
        type: boolean
        description: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.
      configurationPolicyGroupAssociations:
        type: array
        readOnly: true
        items:
          $ref: ./network.json#/definitions/SubResource
        description: List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to.
      previousConfigurationPolicyGroupAssociations:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/VpnServerConfigurationPolicyGroup'
        description: List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to.
      provisioningState:
        readOnly: true
        $ref: ./network.json#/definitions/ProvisioningState
        description: The provisioning state of the P2SConnectionConfiguration resource.
    description: Parameters for P2SConnectionConfiguration.
  P2SVpnConnectionHealthRequest:
    properties:
      vpnUserNamesFilter:
        type: array
        items:
          type: string
          description: P2S vpn user name.
        description: The list of p2s vpn user names whose p2s vpn connection detailed health to retrieve for.
      outputBlobSasUrl:
        type: string
        description: The sas-url to download the P2S Vpn connection health detail.
    description: List of P2S Vpn connection health request.
  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'
  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.
  VpnServerConfigurationPolicyGroupMember:
    properties:
      name:
        type: string
        description: Name of the VpnServerConfigurationPolicyGroupMember.
      attributeType:
        type: string
        description: The Vpn Policy member attribute type.
        enum:
        - CertificateGroupId
        - AADGroupId
        - RadiusAzureGroupId
        x-ms-enum:
          name: VpnPolicyMemberAttributeType
          modelAsString: true
      attributeValue:
        type: string
        description: The value of Attribute used for this VpnServerConfigurationPolicyGroupMember.
    description: VpnServerConfiguration PolicyGroup member
    type: object
  P2SVpnProfileParameters:
    properties:
      authenticationMethod:
        $ref: ./network.json#/definitions/AuthenticationMethod
        description: VPN client authentication method.
    description: Vpn Client Parameters for package generation.
  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
  P2SVpnConnectionRequest:
    description: List of p2s vpn connections to be disconnected.
    properties:
      vpnConnectionIds:
        type: array
        items:
          type: string
        description: List of p2s vpn connection Ids.
  P2SConnectionConfiguration:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/P2SConnectionConfigurationProperties'
        description: Properties of the P2S connection configuration.
      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: P2SConnectionConfiguration Resource.
  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.
  P2SVpnGatewayProperties:
    properties:
      virtualHub:
        $ref: ./network.json#/definitions/SubResource
        description: The VirtualHub to which the gateway belongs.
      p2SConnectionConfigurations:
        type: array
        description: List of all p2s connection configurations of the gateway.
        items:
          $ref: '#/definitions/P2SConnectionConfiguration'
      provisioningState:
        readOnly: true
        $ref: ./network.json#/definitions/ProvisioningState
        description: The provisioning state of the P2S VPN gateway resource.
      vpnGatewayScaleUnit:
        type: integer
        format: int32
        description: The scale unit for this p2s vpn gateway.
      vpnServerConfiguration:
        $ref: ./network.json#/definitions/SubResource
        description: The VpnServerConfiguration to which the p2sVpnGateway is attached to.
      vpnClientConnectionHealth:
        readOnly: true
        $ref: '#/definitions/VpnClientConnectionHealth'
        description: All P2S VPN clients' connection health status.
      customDnsServers:
        type: array
        description: List of all customer specified DNS servers IP addresses.
        items:
          type: string
      isRoutingPreferenceInternet:
        type: boolean
        description: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
    description: Parameters for P2SVpnGateway.
  P2SVpnConnectionHealth:
    properties:
      sasUrl:
        type: string
        description: Returned sas url of the blob to which the p2s vpn connection detailed health will be written.
    description: P2S Vpn connection detailed health written to sas url.
  P2SVpnGateway:
    required:
    - location
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/P2SVpnGatewayProperties'
        description: Properties of the P2SVpnGateway.
      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: P2SVpnGateway Resource.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'