VirtualNetworkGatewayConnections.yml

### YamlMime:TSType
name: VirtualNetworkGatewayConnections
uid: '@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnections'
package: '@azure/arm-network-profile-2020-09-01-hybrid'
summary: Interface representing a VirtualNetworkGatewayConnections.
fullName: VirtualNetworkGatewayConnections
remarks: ''
isDeprecated: false
type: interface
methods:
  - name: >-
      beginCreateOrUpdate(string, string, VirtualNetworkGatewayConnection,
      VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams)
    uid: >-
      @azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnections.beginCreateOrUpdate
    package: '@azure/arm-network-profile-2020-09-01-hybrid'
    summary: >-
      Creates or updates a virtual network gateway connection in the specified
      resource group.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginCreateOrUpdate(resourceGroupName: string,
        virtualNetworkGatewayConnectionName: string, parameters:
        VirtualNetworkGatewayConnection, options?:
        VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams):
        Promise<PollerLike<PollOperationState<VirtualNetworkGatewayConnection>,
        VirtualNetworkGatewayConnection>>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: virtualNetworkGatewayConnectionName
          type: string
          description: The name of the virtual network gateway connection.
        - id: parameters
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnection"
            />
          description: >-
            Parameters supplied to the create or update virtual network gateway
            connection
                              operation.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.PollerLike" />&lt;<xref
          uid="@azure/core-lro.PollOperationState" />&lt;<xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnection"
          />&gt;, <xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnection"
          />&gt;&gt;
  - name: >-
      beginCreateOrUpdateAndWait(string, string,
      VirtualNetworkGatewayConnection,
      VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams)
    uid: >-
      @azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnections.beginCreateOrUpdateAndWait
    package: '@azure/arm-network-profile-2020-09-01-hybrid'
    summary: >-
      Creates or updates a virtual network gateway connection in the specified
      resource group.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginCreateOrUpdateAndWait(resourceGroupName: string,
        virtualNetworkGatewayConnectionName: string, parameters:
        VirtualNetworkGatewayConnection, options?:
        VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams):
        Promise<VirtualNetworkGatewayConnection>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: virtualNetworkGatewayConnectionName
          type: string
          description: The name of the virtual network gateway connection.
        - id: parameters
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnection"
            />
          description: >-
            Parameters supplied to the create or update virtual network gateway
            connection
                              operation.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnectionsCreateOrUpdateOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnection"
          />&gt;
  - name: >-
      beginDelete(string, string,
      VirtualNetworkGatewayConnectionsDeleteOptionalParams)
    uid: >-
      @azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnections.beginDelete
    package: '@azure/arm-network-profile-2020-09-01-hybrid'
    summary: Deletes the specified virtual network Gateway connection.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginDelete(resourceGroupName: string,
        virtualNetworkGatewayConnectionName: string, options?:
        VirtualNetworkGatewayConnectionsDeleteOptionalParams):
        Promise<PollerLike<PollOperationState<void>, void>>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: virtualNetworkGatewayConnectionName
          type: string
          description: The name of the virtual network gateway connection.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnectionsDeleteOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.PollerLike" />&lt;<xref
          uid="@azure/core-lro.PollOperationState" />&lt;void&gt;, void&gt;&gt;
  - name: >-
      beginDeleteAndWait(string, string,
      VirtualNetworkGatewayConnectionsDeleteOptionalParams)
    uid: >-
      @azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnections.beginDeleteAndWait
    package: '@azure/arm-network-profile-2020-09-01-hybrid'
    summary: Deletes the specified virtual network Gateway connection.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginDeleteAndWait(resourceGroupName: string,
        virtualNetworkGatewayConnectionName: string, options?:
        VirtualNetworkGatewayConnectionsDeleteOptionalParams): Promise<void>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: virtualNetworkGatewayConnectionName
          type: string
          description: The name of the virtual network gateway connection.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnectionsDeleteOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;void&gt;
  - name: >-
      beginResetSharedKey(string, string, ConnectionResetSharedKey,
      VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams)
    uid: >-
      @azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnections.beginResetSharedKey
    package: '@azure/arm-network-profile-2020-09-01-hybrid'
    summary: >-
      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.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginResetSharedKey(resourceGroupName: string,
        virtualNetworkGatewayConnectionName: string, parameters:
        ConnectionResetSharedKey, options?:
        VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams):
        Promise<PollerLike<PollOperationState<ConnectionResetSharedKey>,
        ConnectionResetSharedKey>>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: virtualNetworkGatewayConnectionName
          type: string
          description: |-
            The virtual network gateway connection reset shared key
                                                       Name.
        - id: parameters
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.ConnectionResetSharedKey"
            />
          description: >-
            Parameters supplied to the begin reset virtual network gateway
            connection shared
                              key operation through network resource provider.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.PollerLike" />&lt;<xref
          uid="@azure/core-lro.PollOperationState" />&lt;<xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.ConnectionResetSharedKey"
          />&gt;, <xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.ConnectionResetSharedKey"
          />&gt;&gt;
  - name: >-
      beginResetSharedKeyAndWait(string, string, ConnectionResetSharedKey,
      VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams)
    uid: >-
      @azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnections.beginResetSharedKeyAndWait
    package: '@azure/arm-network-profile-2020-09-01-hybrid'
    summary: >-
      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.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginResetSharedKeyAndWait(resourceGroupName: string,
        virtualNetworkGatewayConnectionName: string, parameters:
        ConnectionResetSharedKey, options?:
        VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams):
        Promise<ConnectionResetSharedKey>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: virtualNetworkGatewayConnectionName
          type: string
          description: |-
            The virtual network gateway connection reset shared key
                                                       Name.
        - id: parameters
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.ConnectionResetSharedKey"
            />
          description: >-
            Parameters supplied to the begin reset virtual network gateway
            connection shared
                              key operation through network resource provider.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnectionsResetSharedKeyOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.ConnectionResetSharedKey"
          />&gt;
  - name: >-
      beginSetSharedKey(string, string, ConnectionSharedKey,
      VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams)
    uid: >-
      @azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnections.beginSetSharedKey
    package: '@azure/arm-network-profile-2020-09-01-hybrid'
    summary: >-
      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.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginSetSharedKey(resourceGroupName: string,
        virtualNetworkGatewayConnectionName: string, parameters:
        ConnectionSharedKey, options?:
        VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams):
        Promise<PollerLike<PollOperationState<ConnectionSharedKey>,
        ConnectionSharedKey>>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: virtualNetworkGatewayConnectionName
          type: string
          description: The virtual network gateway connection name.
        - id: parameters
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.ConnectionSharedKey"
            />
          description: >-
            Parameters supplied to the Begin Set Virtual Network Gateway
            connection Shared key
                              operation throughNetwork resource provider.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.PollerLike" />&lt;<xref
          uid="@azure/core-lro.PollOperationState" />&lt;<xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.ConnectionSharedKey"
          />&gt;, <xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.ConnectionSharedKey"
          />&gt;&gt;
  - name: >-
      beginSetSharedKeyAndWait(string, string, ConnectionSharedKey,
      VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams)
    uid: >-
      @azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnections.beginSetSharedKeyAndWait
    package: '@azure/arm-network-profile-2020-09-01-hybrid'
    summary: >-
      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.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginSetSharedKeyAndWait(resourceGroupName: string,
        virtualNetworkGatewayConnectionName: string, parameters:
        ConnectionSharedKey, options?:
        VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams):
        Promise<ConnectionSharedKey>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: virtualNetworkGatewayConnectionName
          type: string
          description: The virtual network gateway connection name.
        - id: parameters
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.ConnectionSharedKey"
            />
          description: >-
            Parameters supplied to the Begin Set Virtual Network Gateway
            connection Shared key
                              operation throughNetwork resource provider.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnectionsSetSharedKeyOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.ConnectionSharedKey"
          />&gt;
  - name: >-
      beginUpdateTags(string, string, TagsObject,
      VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams)
    uid: >-
      @azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnections.beginUpdateTags
    package: '@azure/arm-network-profile-2020-09-01-hybrid'
    summary: Updates a virtual network gateway connection tags.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginUpdateTags(resourceGroupName: string,
        virtualNetworkGatewayConnectionName: string, parameters: TagsObject,
        options?: VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams):
        Promise<PollerLike<PollOperationState<VirtualNetworkGatewayConnection>,
        VirtualNetworkGatewayConnection>>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: virtualNetworkGatewayConnectionName
          type: string
          description: The name of the virtual network gateway connection.
        - id: parameters
          type: >-
            <xref uid="@azure/arm-network-profile-2020-09-01-hybrid.TagsObject"
            />
          description: >-
            Parameters supplied to update virtual network gateway connection
            tags.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.PollerLike" />&lt;<xref
          uid="@azure/core-lro.PollOperationState" />&lt;<xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnection"
          />&gt;, <xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnection"
          />&gt;&gt;
  - name: >-
      beginUpdateTagsAndWait(string, string, TagsObject,
      VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams)
    uid: >-
      @azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnections.beginUpdateTagsAndWait
    package: '@azure/arm-network-profile-2020-09-01-hybrid'
    summary: Updates a virtual network gateway connection tags.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginUpdateTagsAndWait(resourceGroupName: string,
        virtualNetworkGatewayConnectionName: string, parameters: TagsObject,
        options?: VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams):
        Promise<VirtualNetworkGatewayConnection>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: virtualNetworkGatewayConnectionName
          type: string
          description: The name of the virtual network gateway connection.
        - id: parameters
          type: >-
            <xref uid="@azure/arm-network-profile-2020-09-01-hybrid.TagsObject"
            />
          description: >-
            Parameters supplied to update virtual network gateway connection
            tags.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnectionsUpdateTagsOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnection"
          />&gt;
  - name: get(string, string, VirtualNetworkGatewayConnectionsGetOptionalParams)
    uid: >-
      @azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnections.get
    package: '@azure/arm-network-profile-2020-09-01-hybrid'
    summary: Gets the specified virtual network gateway connection by resource group.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function get(resourceGroupName: string,
        virtualNetworkGatewayConnectionName: string, options?:
        VirtualNetworkGatewayConnectionsGetOptionalParams):
        Promise<VirtualNetworkGatewayConnection>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: virtualNetworkGatewayConnectionName
          type: string
          description: The name of the virtual network gateway connection.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnectionsGetOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnection"
          />&gt;
  - name: >-
      getSharedKey(string, string,
      VirtualNetworkGatewayConnectionsGetSharedKeyOptionalParams)
    uid: >-
      @azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnections.getSharedKey
    package: '@azure/arm-network-profile-2020-09-01-hybrid'
    summary: >-
      The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves
      information about the specified

      virtual network gateway connection shared key through Network resource
      provider.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getSharedKey(resourceGroupName: string,
        virtualNetworkGatewayConnectionName: string, options?:
        VirtualNetworkGatewayConnectionsGetSharedKeyOptionalParams):
        Promise<ConnectionSharedKey>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: virtualNetworkGatewayConnectionName
          type: string
          description: The virtual network gateway connection shared key name.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnectionsGetSharedKeyOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.ConnectionSharedKey"
          />&gt;
  - name: list(string, VirtualNetworkGatewayConnectionsListOptionalParams)
    uid: >-
      @azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnections.list
    package: '@azure/arm-network-profile-2020-09-01-hybrid'
    summary: >-
      The List VirtualNetworkGatewayConnections operation retrieves all the
      virtual network gateways

      connections created.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function list(resourceGroupName: string, options?:
        VirtualNetworkGatewayConnectionsListOptionalParams):
        PagedAsyncIterableIterator<VirtualNetworkGatewayConnection,
        VirtualNetworkGatewayConnection[], PageSettings>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnectionsListOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          <xref uid="@azure/core-paging.PagedAsyncIterableIterator" />&lt;<xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnection"
          />, <xref
          uid="@azure/arm-network-profile-2020-09-01-hybrid.VirtualNetworkGatewayConnection"
          />[], <xref uid="@azure/core-paging.PageSettings" />&gt;