swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector VpnSites API
schemes:
- https
tags:
- name: VpnSites
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}:
    patch:
      tags:
      - VpnSites
      operationId: microsoftAzureVpnsitesUpdatetags
      x-ms-examples:
        VpnSiteUpdate:
          $ref: ./examples/VpnSiteUpdateTags.json
      description: Updates VpnSite tags.
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The resource group name of the VpnSite.
      - name: vpnSiteName
        in: path
        required: true
        type: string
        description: The name of the VpnSite being updated.
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - name: VpnSiteParameters
        in: body
        required: true
        schema:
          $ref: ./network.json#/definitions/TagsObject
        description: Parameters supplied to update VpnSite tags.
      responses:
        '200':
          description: Request successful. Returns the details of the VpnSite updated.
          schema:
            $ref: '#/definitions/VpnSite'
        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 Vpnsites Vpnsitename
definitions:
  VpnSite:
    required:
    - location
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/VpnSiteProperties'
        description: Properties of the VPN site.
      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: VpnSite Resource.
  DeviceProperties:
    properties:
      deviceVendor:
        type: string
        description: Name of the device Vendor.
      deviceModel:
        type: string
        description: Model of the device.
      linkSpeedInMbps:
        type: integer
        format: int32
        description: Link speed.
    description: List of properties of the device.
  VpnLinkProviderProperties:
    properties:
      linkProviderName:
        type: string
        description: Name of the link provider.
      linkSpeedInMbps:
        type: integer
        format: int32
        description: Link speed.
    description: List of properties of a link provider.
  VpnSiteLinkProperties:
    properties:
      linkProperties:
        description: The link provider properties.
        $ref: '#/definitions/VpnLinkProviderProperties'
      ipAddress:
        type: string
        description: The ip-address for the vpn-site-link.
      fqdn:
        type: string
        description: FQDN of vpn-site-link.
      bgpProperties:
        $ref: '#/definitions/VpnLinkBgpSettings'
        description: The set of bgp properties.
      provisioningState:
        readOnly: true
        $ref: ./network.json#/definitions/ProvisioningState
        description: The provisioning state of the VPN site link resource.
    description: Parameters for VpnSite.
  O365BreakOutCategoryPolicies:
    properties:
      allow:
        type: boolean
        readOnly: false
        description: Flag to control allow category.
      optimize:
        type: boolean
        readOnly: false
        description: Flag to control optimize category.
      default:
        type: boolean
        readOnly: false
        description: Flag to control default category.
    description: Office365 breakout categories.
  VpnLinkBgpSettings:
    properties:
      asn:
        type: integer
        format: int64
        description: The BGP speaker's ASN.
      bgpPeeringAddress:
        type: string
        description: The BGP peering address and BGP identifier of this BGP speaker.
    description: BGP settings details for a link.
  VpnSiteLink:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/VpnSiteLinkProperties'
        description: Properties of the VPN site link.
      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: VpnSiteLink Resource.
  O365PolicyProperties:
    properties:
      breakOutCategories:
        readOnly: false
        description: Office365 breakout categories.
        $ref: '#/definitions/O365BreakOutCategoryPolicies'
    description: The Office365 breakout policy.
  VpnSiteProperties:
    properties:
      virtualWan:
        $ref: ./network.json#/definitions/SubResource
        description: The VirtualWAN to which the vpnSite belongs.
      deviceProperties:
        description: The device properties.
        $ref: '#/definitions/DeviceProperties'
      ipAddress:
        type: string
        description: The ip-address for the vpn-site.
      siteKey:
        type: string
        description: The key for vpn-site that can be used for connections.
      addressSpace:
        $ref: ./virtualNetwork.json#/definitions/AddressSpace
        description: The AddressSpace that contains an array of IP address ranges.
      bgpProperties:
        $ref: ./virtualNetworkGateway.json#/definitions/BgpSettings
        description: The set of bgp properties.
      provisioningState:
        readOnly: true
        $ref: ./network.json#/definitions/ProvisioningState
        description: The provisioning state of the VPN site resource.
      isSecuritySite:
        type: boolean
        description: IsSecuritySite flag.
      vpnSiteLinks:
        type: array
        description: List of all vpn site links.
        items:
          $ref: '#/definitions/VpnSiteLink'
      o365Policy:
        readOnly: false
        description: Office365 Policy.
        $ref: '#/definitions/O365PolicyProperties'
    description: Parameters for VpnSite.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'