swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector VpnServerConfigurations API
schemes:
- https
tags:
- name: VpnServerConfigurations
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}
  : patch:
      tags:
      - VpnServerConfigurations
      operationId: microsoftAzureVpnserverconfigurationsUpdatetags
      x-ms-examples:
        VpnServerConfigurationUpdate:
          $ref: ./examples/VpnServerConfigurationUpdateTags.json
      description: Updates VpnServerConfiguration tags.
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The resource group name of the VpnServerConfiguration.
      - name: vpnServerConfigurationName
        in: path
        required: true
        type: string
        description: The name of the VpnServerConfiguration being updated.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - name: VpnServerConfigurationParameters
        in: body
        required: true
        schema:
          $ref: ./network.json#/definitions/TagsObject
        description: Parameters supplied to update VpnServerConfiguration tags.
      responses:
        '200':
          description: Request successful. Returns the details of the VpnServerConfiguration updated.
          schema:
            $ref: '#/definitions/VpnServerConfiguration'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname
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.
  VpnServerConfigRadiusClientRootCertificate:
    properties:
      name:
        type: string
        description: The certificate name.
      thumbprint:
        type: string
        description: The Radius client root certificate thumbprint.
    description: Properties of the Radius client root certificate of VpnServerConfiguration.
  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.
  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
  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
  VpnServerConfigRadiusServerRootCertificate:
    properties:
      name:
        type: string
        description: The certificate name.
      publicCertData:
        type: string
        description: The certificate public data.
    description: Properties of Radius Server root certificate of VpnServerConfiguration.
  AadAuthenticationParameters:
    properties:
      aadTenant:
        type: string
        description: AAD Vpn authentication parameter AAD tenant.
      aadAudience:
        type: string
        description: AAD Vpn authentication parameter AAD audience.
      aadIssuer:
        type: string
        description: AAD Vpn authentication parameter AAD issuer.
    description: AAD Vpn authentication type related parameters.
  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.
  VpnServerConfigVpnClientRevokedCertificate:
    properties:
      name:
        type: string
        description: The certificate name.
      thumbprint:
        type: string
        description: The revoked VPN client certificate thumbprint.
    description: Properties of the revoked VPN client certificate of VpnServerConfiguration.
  VpnServerConfigVpnClientRootCertificate:
    properties:
      name:
        type: string
        description: The certificate name.
      publicCertData:
        type: string
        description: The certificate public data.
    description: Properties of VPN client root certificate of VpnServerConfiguration.
  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.
  VpnServerConfiguration:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/VpnServerConfigurationProperties'
        description: Properties of the P2SVpnServer 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/Resource
    description: VpnServerConfiguration Resource.
  VpnServerConfigurationProperties:
    properties:
      name:
        type: string
        description: The name of the VpnServerConfiguration that is unique within a resource group.
      vpnProtocols:
        type: array
        items:
          type: string
          description: VPN protocol enabled for the VpnServerConfiguration.
          enum:
          - IkeV2
          - OpenVPN
          x-ms-enum:
            name: VpnGatewayTunnelingProtocol
            modelAsString: true
        description: VPN protocols for the VpnServerConfiguration.
      vpnAuthenticationTypes:
        type: array
        items:
          type: string
          description: VPN authentication types enabled for the VpnServerConfiguration.
          enum:
          - Certificate
          - Radius
          - AAD
          x-ms-enum:
            name: VpnAuthenticationType
            modelAsString: true
        description: VPN authentication types for the VpnServerConfiguration.
      vpnClientRootCertificates:
        type: array
        items:
          $ref: '#/definitions/VpnServerConfigVpnClientRootCertificate'
        description: VPN client root certificate of VpnServerConfiguration.
      vpnClientRevokedCertificates:
        type: array
        items:
          $ref: '#/definitions/VpnServerConfigVpnClientRevokedCertificate'
        description: VPN client revoked certificate of VpnServerConfiguration.
      radiusServerRootCertificates:
        type: array
        items:
          $ref: '#/definitions/VpnServerConfigRadiusServerRootCertificate'
        description: Radius Server root certificate of VpnServerConfiguration.
      radiusClientRootCertificates:
        type: array
        items:
          $ref: '#/definitions/VpnServerConfigRadiusClientRootCertificate'
        description: Radius client root certificate of VpnServerConfiguration.
      vpnClientIpsecPolicies:
        type: array
        items:
          $ref: ./virtualNetworkGateway.json#/definitions/IpsecPolicy
        description: VpnClientIpsecPolicies for VpnServerConfiguration.
      radiusServerAddress:
        type: string
        description: The radius server address property of the VpnServerConfiguration resource for point to site client connection.
      radiusServerSecret:
        type: string
        description: The radius secret property of the VpnServerConfiguration resource for point to site client connection.
      radiusServers:
        type: array
        items:
          $ref: ./virtualNetworkGateway.json#/definitions/RadiusServer
        description: Multiple Radius Server configuration for VpnServerConfiguration.
      aadAuthenticationParameters:
        $ref: '#/definitions/AadAuthenticationParameters'
        description: The set of aad vpn authentication parameters.
      provisioningState:
        readOnly: true
        type: string
        description: 'The provisioning state of the VpnServerConfiguration resource. Possible values are: ''Updating'', ''Deleting'', and ''Failed''.'
      p2SVpnGateways:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/P2SVpnGateway'
        description: List of references to P2SVpnGateways.
      configurationPolicyGroups:
        type: array
        description: List of all VpnServerConfigurationPolicyGroups.
        items:
          $ref: '#/definitions/VpnServerConfigurationPolicyGroup'
      etag:
        readOnly: true
        type: string
        description: A unique read-only string that changes whenever the resource is updated.
    description: Parameters for VpnServerConfiguration.
  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'