swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector VirtualNetworkGatewayConnections API
schemes:
- https
tags:
- name: VirtualNetworkGatewayConnections
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Network.Admin/adminVirtualNetworkGatewayConnections:
    get:
      x-ms-examples:
        Returns a list of all virtual network gateway connections.:
          $ref: ./examples/VirtualNetworkGatewayConnections/List.json
      tags:
      - VirtualNetworkGatewayConnections
      operationId: microsoftAzureVirtualnetworkgatewayconnectionsList
      description: Returns a list of all Virtual Network Gateway Connections.
      parameters:
      - $ref: ../../preview/2015-06-15/Network.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - $ref: ../../preview/2015-06-15/Network.json#/parameters/FilterParameter
      - $ref: ../../preview/2015-06-15/Network.json#/parameters/OrderByParameter
      - $ref: ../../preview/2015-06-15/Network.json#/parameters/TopParameter
      responses:
        '200':
          description: OK -- The list of virtual network gateway connections has been returned.
          schema:
            $ref: '#/definitions/VirtualNetworkGatewayConnectionsList'
        default:
          description: Error Response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Admin Adminvirtualnetworkgatewayconnections
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}
  : put:
      tags:
      - VirtualNetworkGatewayConnections
      operationId: microsoftAzureVirtualnetworkgatewayconnectionsCreateorupdate
      description: The Put VirtualNetworkGatewayConnection operation creates/updates a virtual network gateway connection in the specified resource group through Network resource provider.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: virtualNetworkGatewayConnectionName
        in: path
        required: true
        type: string
        description: The name of the virtual network gateway connection.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/VirtualNetworkGatewayConnection_2'
        description: Parameters supplied to the Begin Create or update Virtual Network Gateway connection operation through Network resource provider.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/VirtualNetworkGatewayConnection_2'
        '201':
          description: ''
          schema:
            $ref: '#/definitions/VirtualNetworkGatewayConnection_2'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Connections Virtualnetworkgatewayconnectionname
    get:
      tags:
      - VirtualNetworkGatewayConnections
      operationId: microsoftAzureVirtualnetworkgatewayconnectionsGet
      description: The Get VirtualNetworkGatewayConnection operation retrieves information about the specified virtual network gateway connection through Network resource provider.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: virtualNetworkGatewayConnectionName
        in: path
        required: true
        type: string
        description: The name of the virtual network gateway connection.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/VirtualNetworkGatewayConnection_2'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Connections Virtualnetworkgatewayconnectionname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/
  : delete:
      tags:
      - VirtualNetworkGatewayConnections
      operationId: microsoftAzureVirtualnetworkgatewayconnectionsDelete
      description: The Delete VirtualNetworkGatewayConnection operation deletes the specified virtual network Gateway connection through Network resource provider.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: virtualNetworkGatewayConnectionName
        in: path
        required: true
        type: string
        description: The name of the virtual network gateway connection.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
        '202':
          description: ''
        '204':
          description: ''
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Connections Virtualnetworkgatewayconnectionname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey
  : get:
      tags:
      - VirtualNetworkGatewayConnections
      operationId: microsoftAzureVirtualnetworkgatewayconnectionsGetsharedkey
      description: The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: virtualNetworkGatewayConnectionName
        in: path
        required: true
        type: string
        description: The virtual network gateway connection shared key name.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/ConnectionSharedKey'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Connections Virtualnetworkgatewayconnectionname Sharedkey
    put:
      tags:
      - VirtualNetworkGatewayConnections
      operationId: microsoftAzureVirtualnetworkgatewayconnectionsSetsharedkey
      description: The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: virtualNetworkGatewayConnectionName
        in: path
        required: true
        type: string
        description: The virtual network gateway connection name.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ConnectionSharedKey'
        description: Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation through Network resource provider.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/ConnectionSharedKey'
        '201':
          description: ''
          schema:
            $ref: '#/definitions/ConnectionSharedKey'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Connections Virtualnetworkgatewayconnectionname Sharedkey
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections:
    get:
      tags:
      - VirtualNetworkGatewayConnections
      operationId: microsoftAzureVirtualnetworkgatewayconnectionsList
      description: The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/VirtualNetworkGatewayConnectionListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Connections
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey/reset
  : post:
      tags:
      - VirtualNetworkGatewayConnections
      operationId: microsoftAzureVirtualnetworkgatewayconnectionsResetsharedkey
      description: The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: virtualNetworkGatewayConnectionName
        in: path
        required: true
        type: string
        description: The virtual network gateway connection reset shared key Name.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ConnectionResetSharedKey'
        description: Parameters supplied to the Begin Reset Virtual Network Gateway connection shared key operation through Network resource provider.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/ConnectionResetSharedKey'
        '202':
          description: ''
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Connections Virtualnetworkgatewayconnectionname Sharedkey Reset
definitions:
  ConnectionResetSharedKey:
    properties:
      keyLength:
        type: integer
        format: int64
        description: The virtual network connection reset shared key length
  VirtualNetworkGatewayIpConfiguration:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/VirtualNetworkGatewayIpConfigurationPropertiesFormat'
      name:
        type: string
        description: Gets name of the resource that is unique within a resource group. This name can be used to access the resource
      etag:
        type: string
        description: A unique read-only string that changes whenever the resource is updated
    allOf:
    - $ref: '#/definitions/SubResource'
    description: IpConfiguration for Virtual network gateway
  VirtualNetworkGatewayConnectionsList:
    description: List of Virtual Network Gateway Connections.
    type: object
    properties:
      value:
        description: List of Virtual Network Gateway Connections.
        type: array
        items:
          $ref: '#/definitions/VirtualNetworkGatewayConnection'
        x-ms-identifiers: []
        readOnly: true
      nextLink:
        description: URI to the next page.
        type: string
        readOnly: true
  VirtualNetworkGatewayIpConfigurationPropertiesFormat:
    properties:
      privateIPAddress:
        type: string
        description: Gets or sets the privateIPAddress of the Network Interface IP Configuration
      privateIPAllocationMethod:
        type: string
        description: Gets or sets PrivateIP allocation method (Static/Dynamic)
        enum:
        - Static
        - Dynamic
        x-ms-enum:
          name: IpAllocationMethod
          modelAsString: true
      subnet:
        $ref: '#/definitions/SubResource'
        description: Gets or sets the reference of the subnet resource
      publicIPAddress:
        $ref: '#/definitions/SubResource'
        description: Gets or sets the reference of the PublicIP resource
      provisioningState:
        type: string
        description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
    description: Properties of VirtualNetworkGatewayIPConfiguration
  AddressSpace:
    properties:
      addressPrefixes:
        type: array
        items:
          type: string
        description: Gets or sets List of address blocks reserved for this virtual network in CIDR notation
    description: AddressSpace contains an array of IP address ranges that can be used by subnets
  LocalNetworkGatewayPropertiesFormat:
    properties:
      localNetworkAddressSpace:
        $ref: '#/definitions/AddressSpace'
        description: Local network site Address space
      gatewayIpAddress:
        type: string
        description: IP address of local network gateway.
      resourceGuid:
        type: string
        description: Gets or sets resource guid property of the LocalNetworkGateway resource
      provisioningState:
        type: string
        description: Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed
    description: LocalNetworkGateway properties
  Resource:
    properties:
      id:
        readOnly: true
        type: string
        description: Resource Id
      name:
        readOnly: true
        type: string
        description: Resource name
      type:
        readOnly: true
        type: string
        description: Resource type
      location:
        type: string
        description: Resource location
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags
    required:
    - location
    x-ms-azure-resource: true
  VirtualNetworkGatewayConnection_2:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat'
      etag:
        type: string
        description: Gets a unique read-only string that changes whenever the resource is updated
    allOf:
    - $ref: '#/definitions/Resource'
    description: A common class for general resource information
  ConnectionSharedKey:
    properties:
      value:
        type: string
        description: The virtual network connection shared key value
    description: Response for GetConnectionSharedKey Api service call
  SubResource:
    properties:
      id:
        type: string
        description: Resource Id
    x-ms-azure-resource: true
  VirtualNetworkGatewayConnection:
    description: The Virtual Network Gateway Connection.
    type: object
    properties:
      properties:
        description: Virtual Network Gateway Connection properties.
        x-ms-client-flatten: true
        $ref: '#/definitions/VirtualNetworkGatewayConnectionProperties'
      location:
        description: Name of Azure Stack
        type: string
        readOnly: true
    allOf:
    - $ref: ../../preview/2015-06-15/Network.json#/definitions/Resource
  VirtualNetworkGatewayConnectionListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/VirtualNetworkGatewayConnection_2'
        description: Gets List of VirtualNetworkGatewayConnections that exists in a resource group
      nextLink:
        type: string
        description: Gets the URL to get the next set of results.
    description: Response for ListVirtualNetworkGatewayConnections Api service call
  VirtualNetworkGatewayConnectionState:
    description: Virtual Network Gateway Connection state.
    type: object
    properties:
      status:
        description: Virtual Network Gateway Connection status.
        enum:
        - Connected
        - Disconnected
        - Uninitialized
        - Unknown
        type: string
        readOnly: true
        x-ms-enum:
          modelAsString: true
          name: VirtualNetworkGatewayConnectionConnectionStateType
      activeGateway:
        description: Active Gateway VM that the connection is configured on.
        type: string
        readOnly: true
      connectionError:
        description: List of connection errors associated with the resource.
        $ref: '#/definitions/VirtualNetworkGatewayConnectionConfigurationStatus'
        readOnly: true
  VirtualNetworkGatewayConnectionProperties:
    description: Virtual Network Gateway Connection properties.
    type: object
    properties:
      connectionState:
        description: Virtual Network Gateway Connection State.
        $ref: '#/definitions/VirtualNetworkGatewayConnectionState'
      provisioningState:
        description: Provisioning State of the Virtual Network Gateway Connection.
        type: string
        enum:
        - Succeeded
        - Updating
        - Deleting
        - Failed
        x-ms-enum:
          modelAsString: true
          name: VirtualNetworkGatewayConnectionProvisioningState
        readOnly: true
      subscriptionId:
        description: Subscription Id of the Virtual Network Gateway Connection.
        type: string
        readOnly: true
      resourceGroup:
        description: Resource Group of the Virtual Network Gateway Connection.
        type: string
        readOnly: true
      localNetworkGatewayName:
        description: Name of the associated Local Network Gateway.
        type: string
        readOnly: true
      localNetworkGatewayIPAddress:
        description: IP address of the associated Local Network Gateway.
        type: string
        readOnly: true
      virtualNetworkGatewayName:
        description: Name of the associated Virtual Network Gateway.
        type: string
        readOnly: true
      virtualNetworkGatewayIPAddress:
        description: IP address of the associated Virtual Network Gateway.
        type: string
        readOnly: true
      sku:
        description: SKU of the associated Virtual Network Gateway.
        type: string
        enum:
        - Basic
        - Standard
        - HighPerformance
        - VpnGw1
        - VpnGw2
        - VpnGw3
        x-ms-enum:
          modelAsString: true
          name: VirtualNetworkGatewayConnectionSku
        readOnly: true
      capacityReserved:
        description: Gateway capacity reserved by this connection.
        type: number
        readOnly: true
      totalStampCapacity:
        description: Total amount of Gateway capacity that is available on this stamp.
        type: number
        readOnly: true
  VirtualNetworkGatewayConnectionConfigurationStateInfo:
    description: Virtual network gateway connection state and error code.
    type: object
    properties:
      source:
        description: Source of the error message.
        type: string
        readOnly: true
      code:
        description: Error code if the connection is disconnected and self-diagnosable.
        type: string
        readOnly: true
      message:
        description: Message associated with the error code.
        type: string
        readOnly: true
  VirtualNetworkGatewayConnectionConfigurationStatus:
    description: Virtual Network Gateway Connection configuration status.
    type: object
    properties:
      status:
        description: Virtual Network Gateway Connection configuration status.
        enum:
        - Failure
        - Warning
        - Success
        - Uninitialized
        - InProgress
        - Unknown
        type: string
        x-ms-enum:
          modelAsString: true
          name: VirtualNetworkGatewayConnectionConfigurationType
        readOnly: true
      lastUpdatedTime:
        description: Last updated time for the configuration status.
        type: string
        format: date-time
        readOnly: true
      detailedInfo:
        description: List of connection errors associated with the resource.
        type: array
        items:
          $ref: '#/definitions/VirtualNetworkGatewayConnectionConfigurationStateInfo'
        x-ms-identifiers: []
  VirtualNetworkGatewayConnectionPropertiesFormat:
    properties:
      virtualNetworkGateway1:
        $ref: '#/definitions/VirtualNetworkGateway'
      virtualNetworkGateway2:
        $ref: '#/definitions/VirtualNetworkGateway'
      localNetworkGateway2:
        $ref: '#/definitions/LocalNetworkGateway'
      connectionType:
        type: string
        description: Gateway connection type IPsec/Dedicated/VpnClient/Vnet2Vnet
        enum:
        - IPsec
        - Vnet2Vnet
        - ExpressRoute
        - VPNClient
        x-ms-enum:
          name: VirtualNetworkGatewayConnectionType
          modelAsString: true
      routingWeight:
        type: integer
        format: int32
        description: The Routing weight.
      sharedKey:
        type: string
        description: The IPsec share key.
      connectionStatus:
        type: string
        description: Virtual network Gateway connection status
        enum:
        - Unknown
        - Connecting
        - Connected
        - NotConnected
        x-ms-enum:
          name: VirtualNetworkGatewayConnectionStatus
          modelAsString: true
      egressBytesTransferred:
        type: integer
        format: int64
        description: The Egress Bytes Transferred in this connection
      ingressBytesTransferred:
        type: integer
        format: int64
        description: The Ingress Bytes Transferred in this connection
      peer:
        $ref: '#/definitions/SubResource'
        description: The reference to peerings resource.
      resourceGuid:
        type: string
        description: Gets or sets resource guid property of the VirtualNetworkGatewayConnection resource
      provisioningState:
        type: string
        description: Gets or sets Provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed
    description: VirtualNetworkGatewayConnection properties
  VirtualNetworkGatewayPropertiesFormat:
    properties:
      ipConfigurations:
        type: array
        items:
          $ref: '#/definitions/VirtualNetworkGatewayIpConfiguration'
        description: IpConfigurations for Virtual network gateway.
      gatewayType:
        type: string
        description: The type of this virtual network gateway.
        enum:
        - Vpn
        - ExpressRoute
        x-ms-enum:
          name: VirtualNetworkGatewayType
          modelAsString: true
      vpnType:
        type: string
        description: The type of this virtual network gateway.
        enum:
        - PolicyBased
        - RouteBased
        x-ms-enum:
          name: VpnType
          modelAsString: true
      enableBgp:
        type: boolean
        description: EnableBgp Flag
      gatewayDefaultSite:
        $ref: '#/definitions/SubResource'
        description: Gets or sets the reference of the LocalNetworkGateway resource which represents Local network site having default routes. Assign Null value in case of removing existing default site setting.
      resourceGuid:
        type: string
        description: Gets or sets resource guid property of the VirtualNetworkGateway resource
      provisioningState:
        type: string
        description: Gets or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed
    description: VirtualNetworkGateway properties
  LocalNetworkGateway:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/LocalNetworkGatewayPropertiesFormat'
      etag:
        type: string
        description: Gets a unique read-only string that changes whenever the resource is updated
    allOf:
    - $ref: '#/definitions/Resource'
    description: A common class for general resource information
  VirtualNetworkGateway:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/VirtualNetworkGatewayPropertiesFormat'
      etag:
        type: string
        description: Gets a unique read-only string that changes whenever the resource is updated
    allOf:
    - $ref: '#/definitions/Resource'
    description: A common class for general resource information
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'