azure.mgmt.keyvault.v2023_02_01.operations.PrivateEndpointConnectionsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.keyvault.v2023_02_01.operations.PrivateEndpointConnectionsOperations
name: PrivateEndpointConnectionsOperations
fullName: azure.mgmt.keyvault.v2023_02_01.operations.PrivateEndpointConnectionsOperations
module: azure.mgmt.keyvault.v2023_02_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.keyvault.v2023_02_01.KeyVaultManagementClient>'s\n\
  >\n> <xref:private_endpoint_connections> attribute.\n>"
constructor:
  syntax: PrivateEndpointConnectionsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.keyvault.v2023_02_01.operations.PrivateEndpointConnectionsOperations.begin_delete
  name: begin_delete
  summary: Deletes the specified private endpoint connection associated with the key
    vault.
  signature: 'begin_delete(resource_group_name: str, vault_name: str, private_endpoint_connection_name:
    str, **kwargs: Any) -> LROPoller[PrivateEndpointConnection]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group that contains the key vault. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vault_name
    description: The name of the key vault. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: private_endpoint_connection_name
    description: 'Name of the private endpoint connection associated

      with the key vault. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: 'An instance of LROPoller that returns either PrivateEndpointConnection
      or the result

      of cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.keyvault.v2023_02_01.models.PrivateEndpointConnection>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2023_02_01.operations.PrivateEndpointConnectionsOperations.get
  name: get
  summary: Gets the specified private endpoint connection associated with the key
    vault.
  signature: 'get(resource_group_name: str, vault_name: str, private_endpoint_connection_name:
    str, **kwargs: Any) -> PrivateEndpointConnection | None'
  parameters:
  - name: resource_group_name
    description: Name of the resource group that contains the key vault. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vault_name
    description: The name of the key vault. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: private_endpoint_connection_name
    description: 'Name of the private endpoint connection associated

      with the key vault. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: PrivateEndpointConnection or None or the result of cls(response)
    types:
    - <xref:azure.mgmt.keyvault.v2023_02_01.models.PrivateEndpointConnection>
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2023_02_01.operations.PrivateEndpointConnectionsOperations.list_by_resource
  name: list_by_resource
  summary: 'The List operation gets information about the private endpoint connections
    associated with the

    vault.'
  signature: 'list_by_resource(resource_group_name: str, vault_name: str, **kwargs:
    Any) -> Iterable[PrivateEndpointConnection]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group that contains the key vault. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vault_name
    description: The name of the key vault. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: 'An iterator like instance of either PrivateEndpointConnection or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.keyvault.v2023_02_01.models.PrivateEndpointConnection>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2023_02_01.operations.PrivateEndpointConnectionsOperations.put
  name: put
  summary: Updates the specified private endpoint connection associated with the key
    vault.
  signature: 'put(resource_group_name: str, vault_name: str, private_endpoint_connection_name:
    str, properties: _models.PrivateEndpointConnection, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.PrivateEndpointConnection'
  parameters:
  - name: resource_group_name
    description: Name of the resource group that contains the key vault. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vault_name
    description: The name of the key vault. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: private_endpoint_connection_name
    description: 'Name of the private endpoint connection associated

      with the key vault. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: properties
    description: 'The intended state of private endpoint connection. Is either a

      PrivateEndpointConnection type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.keyvault.v2023_02_01.models.PrivateEndpointConnection>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: PrivateEndpointConnection or the result of cls(response)
    types:
    - <xref:azure.mgmt.keyvault.v2023_02_01.models.PrivateEndpointConnection>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.keyvault.v2023_02_01.operations.PrivateEndpointConnectionsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.keyvault.v2023_02_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\keyvault\\v2023_02_01\\models\\__init__.py'>