MhsmPrivateEndpointConnections.yml

### YamlMime:TSType
name: MhsmPrivateEndpointConnections
uid: '@azure/arm-keyvault.MhsmPrivateEndpointConnections'
package: '@azure/arm-keyvault'
summary: Interface representing a MhsmPrivateEndpointConnections.
fullName: MhsmPrivateEndpointConnections
remarks: ''
isDeprecated: false
type: interface
methods:
  - name: >-
      beginDelete(string, string, string,
      MhsmPrivateEndpointConnectionsDeleteOptionalParams)
    uid: '@azure/arm-keyvault.MhsmPrivateEndpointConnections.beginDelete'
    package: '@azure/arm-keyvault'
    summary: >-
      Deletes the specified private endpoint connection associated with the
      managed hsm pool.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginDelete(resourceGroupName: string, name: string,
        privateEndpointConnectionName: string, options?:
        MhsmPrivateEndpointConnectionsDeleteOptionalParams):
        Promise<SimplePollerLike<OperationState<MhsmPrivateEndpointConnection>,
        MhsmPrivateEndpointConnection>>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of the resource group that contains the managed HSM pool.
        - id: name
          type: string
          description: Name of the managed HSM Pool
        - id: privateEndpointConnectionName
          type: string
          description: |-
            Name of the private endpoint connection associated with the
                                                 managed hsm pool.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-keyvault.MhsmPrivateEndpointConnectionsDeleteOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.SimplePollerLike" />&lt;<xref
          uid="@azure/core-lro.OperationState" />&lt;<xref
          uid="@azure/arm-keyvault.MhsmPrivateEndpointConnection" />&gt;, <xref
          uid="@azure/arm-keyvault.MhsmPrivateEndpointConnection" />&gt;&gt;
  - name: >-
      beginDeleteAndWait(string, string, string,
      MhsmPrivateEndpointConnectionsDeleteOptionalParams)
    uid: '@azure/arm-keyvault.MhsmPrivateEndpointConnections.beginDeleteAndWait'
    package: '@azure/arm-keyvault'
    summary: >-
      Deletes the specified private endpoint connection associated with the
      managed hsm pool.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginDeleteAndWait(resourceGroupName: string, name: string,
        privateEndpointConnectionName: string, options?:
        MhsmPrivateEndpointConnectionsDeleteOptionalParams):
        Promise<MhsmPrivateEndpointConnection>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of the resource group that contains the managed HSM pool.
        - id: name
          type: string
          description: Name of the managed HSM Pool
        - id: privateEndpointConnectionName
          type: string
          description: |-
            Name of the private endpoint connection associated with the
                                                 managed hsm pool.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-keyvault.MhsmPrivateEndpointConnectionsDeleteOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-keyvault.MhsmPrivateEndpointConnection" />&gt;
  - name: >-
      get(string, string, string,
      MhsmPrivateEndpointConnectionsGetOptionalParams)
    uid: '@azure/arm-keyvault.MhsmPrivateEndpointConnections.get'
    package: '@azure/arm-keyvault'
    summary: >-
      Gets the specified private endpoint connection associated with the managed
      HSM Pool.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function get(resourceGroupName: string, name: string,
        privateEndpointConnectionName: string, options?:
        MhsmPrivateEndpointConnectionsGetOptionalParams):
        Promise<MhsmPrivateEndpointConnection>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of the resource group that contains the managed HSM pool.
        - id: name
          type: string
          description: Name of the managed HSM Pool
        - id: privateEndpointConnectionName
          type: string
          description: |-
            Name of the private endpoint connection associated with the
                                                 managed hsm pool.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-keyvault.MhsmPrivateEndpointConnectionsGetOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-keyvault.MhsmPrivateEndpointConnection" />&gt;
  - name: >-
      listByResource(string, string,
      MhsmPrivateEndpointConnectionsListByResourceOptionalParams)
    uid: '@azure/arm-keyvault.MhsmPrivateEndpointConnections.listByResource'
    package: '@azure/arm-keyvault'
    summary: >-
      The List operation gets information about the private endpoint connections
      associated with the

      managed HSM Pool.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listByResource(resourceGroupName: string, name: string,
        options?: MhsmPrivateEndpointConnectionsListByResourceOptionalParams):
        PagedAsyncIterableIterator<MhsmPrivateEndpointConnection,
        MhsmPrivateEndpointConnection[], PageSettings>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of the resource group that contains the managed HSM pool.
        - id: name
          type: string
          description: Name of the managed HSM Pool
        - id: options
          type: >-
            <xref
            uid="@azure/arm-keyvault.MhsmPrivateEndpointConnectionsListByResourceOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          <xref uid="@azure/core-paging.PagedAsyncIterableIterator" />&lt;<xref
          uid="@azure/arm-keyvault.MhsmPrivateEndpointConnection" />, <xref
          uid="@azure/arm-keyvault.MhsmPrivateEndpointConnection" />[], <xref
          uid="@azure/core-paging.PageSettings" />&gt;
  - name: >-
      put(string, string, string, MhsmPrivateEndpointConnection,
      MhsmPrivateEndpointConnectionsPutOptionalParams)
    uid: '@azure/arm-keyvault.MhsmPrivateEndpointConnections.put'
    package: '@azure/arm-keyvault'
    summary: >-
      Updates the specified private endpoint connection associated with the
      managed hsm pool.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function put(resourceGroupName: string, name: string,
        privateEndpointConnectionName: string, properties:
        MhsmPrivateEndpointConnection, options?:
        MhsmPrivateEndpointConnectionsPutOptionalParams):
        Promise<MhsmPrivateEndpointConnectionsPutResponse>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of the resource group that contains the managed HSM pool.
        - id: name
          type: string
          description: Name of the managed HSM Pool
        - id: privateEndpointConnectionName
          type: string
          description: |-
            Name of the private endpoint connection associated with the
                                                 managed hsm pool.
        - id: properties
          type: <xref uid="@azure/arm-keyvault.MhsmPrivateEndpointConnection" />
          description: The intended state of private endpoint connection.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-keyvault.MhsmPrivateEndpointConnectionsPutOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-keyvault.MhsmPrivateEndpointConnectionsPutResponse"
          />&gt;