# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Virtual Network Gateway Connections API
  version: 1.0.0
extends: openapi/microsoft-azure-virtualnetworkgatewayconnections-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Network.Admin/adminVirtualNetworkGatewayConnections'].get
  update:
    x-apievangelist-phrasing:
      intent: List gateway connections as an Azure Stack admin
      effect: read
      questions:
      - As an Azure Stack Hub operator, can I see every virtual network gateway connection?
      - Which gateway connections exist across tenants in the admin view?
      instructions:
      - text: List all virtual network gateway connections in the admin view.
      - text: Show every gateway connection as an Azure Stack operator.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a virtual network gateway connection
      effect: read
      questions:
      - What's the configuration of one VPN gateway connection?
      - Can I check the status of a specific site-to-site connection?
      instructions:
      - text: Get gateway connection {virtualNetworkGatewayConnectionName} in resource group {resourceGroupName}.
        slots:
          virtualNetworkGatewayConnectionName: path.virtualNetworkGatewayConnectionName
          resourceGroupName: path.resourceGroupName
      - text: Show connection {virtualNetworkGatewayConnectionName} in group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          virtualNetworkGatewayConnectionName: path.virtualNetworkGatewayConnectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a gateway connection
      effect: write
      questions:
      - How do I connect a virtual network gateway to an on-premises network?
      - Can I change an existing VPN connection's settings?
      instructions:
      - text: Create gateway connection {virtualNetworkGatewayConnectionName} in {location} in resource group {resourceGroupName}.
        slots:
          virtualNetworkGatewayConnectionName: path.virtualNetworkGatewayConnectionName
          location: requestBody.location
          resourceGroupName: path.resourceGroupName
      - text: Create or update connection {virtualNetworkGatewayConnectionName} in group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          virtualNetworkGatewayConnectionName: path.virtualNetworkGatewayConnectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a gateway connection
      effect: destructive
      questions:
      - Can I tear down a VPN gateway connection I no longer need?
      - Is it possible to delete a site-to-site connection?
      instructions:
      - text: Delete gateway connection {virtualNetworkGatewayConnectionName} in resource group {resourceGroupName}.
        slots:
          virtualNetworkGatewayConnectionName: path.virtualNetworkGatewayConnectionName
          resourceGroupName: path.resourceGroupName
      - text: Remove connection {virtualNetworkGatewayConnectionName} from group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          virtualNetworkGatewayConnectionName: path.virtualNetworkGatewayConnectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a gateway connection's shared key
      effect: read
      questions:
      - What's the pre-shared key on my VPN connection?
      - Can I read the IPsec shared key of a gateway connection?
      instructions:
      - text: Get the shared key of connection {virtualNetworkGatewayConnectionName} in {resourceGroupName}.
        slots:
          virtualNetworkGatewayConnectionName: path.virtualNetworkGatewayConnectionName
          resourceGroupName: path.resourceGroupName
      - text: Show the pre-shared key for {virtualNetworkGatewayConnectionName}, group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          virtualNetworkGatewayConnectionName: path.virtualNetworkGatewayConnectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a gateway connection's shared key
      effect: write
      questions:
      - How do I set my own pre-shared key on a VPN connection?
      - Can I replace a connection's shared key with a value I choose?
      instructions:
      - text: Set the shared key of connection {virtualNetworkGatewayConnectionName} in {resourceGroupName} to {value}.
        slots:
          virtualNetworkGatewayConnectionName: path.virtualNetworkGatewayConnectionName
          resourceGroupName: path.resourceGroupName
          value: requestBody.value
      - text: Change the pre-shared key on {virtualNetworkGatewayConnectionName}, group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          virtualNetworkGatewayConnectionName: path.virtualNetworkGatewayConnectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List gateway connections in a resource group
      effect: read
      questions:
      - Which VPN gateway connections are in my resource group?
      - Can I list all connections created in one resource group?
      instructions:
      - text: List gateway connections in resource group {resourceGroupName}.
        slots:
          resourceGroupName: path.resourceGroupName
      - text: Show every connection in group {resourceGroupName} of subscription {subscriptionId}.
        slots:
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a gateway connection's shared key
      effect: destructive
      questions:
      - Can I regenerate the shared key on a VPN connection with a set key length?
      - How do I reset a compromised pre-shared key?
      instructions:
      - text: Reset the shared key of connection {virtualNetworkGatewayConnectionName} in {resourceGroupName}.
        slots:
          virtualNetworkGatewayConnectionName: path.virtualNetworkGatewayConnectionName
          resourceGroupName: path.resourceGroupName
      - text: Regenerate a {keyLength}-character key for {virtualNetworkGatewayConnectionName}, group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          keyLength: requestBody.keyLength
          virtualNetworkGatewayConnectionName: path.virtualNetworkGatewayConnectionName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'