Managed Private Endpoints - Get

Service:

Purview

API Version:

2023-09-01

Gets a managed private endpoint.

GET {endpoint}/scan/managedvirtualnetworks/defaultv2/managedprivateendpoints/{managedPrivateEndpointName}?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (url)	The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com.
managedPrivateEndpointName	path	True	string minLength: 1 maxLength: 127 pattern: ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$	The managed private endpoint name.
managedVirtualNetworkName	path	True	ManagedVirtualNetworkName	The managed virtual network name. It is restricted to the value 'defaultv2' for now.
api-version	query	True	string	The api version to use.

Responses

Name	Type	Description
200 OK	ManagedPrivateEndpoint	Success.
Other Status Codes	ErrorResponseModel	An error response received from the Scanning Service. Headers x-ms-error-code: string

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ManagedPrivateEndpoints_Get

Sample request

HTTP

GET {endpoint}/scan/managedvirtualnetworks/defaultv2/managedprivateendpoints/myManagedPrivateEndpoint?api-version=2023-09-01

Sample response

Status code:

200

x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888

{
  "name": "myManagedPrivateEndpoint",
  "properties": {
    "connectionState": {
      "actionsRequired": "None",
      "description": "test descrption",
      "status": "Approved"
    },
    "fqdns": [
      "fqdns1"
    ],
    "groupId": "myGroupId",
    "privateLinkResourceId": "myPrivateLinkResourceId",
    "provisioningState": "Succeeded"
  }
}

Definitions

Name	Description
ConnectionStateProperties	The properties of connection state.
ErrorModel	The error model.
ErrorResponseModel	The error response model.
ManagedPrivateEndpoint	The managed private endpoint.
ManagedPrivateEndpointProperties	The properties of managed private endpoint.
ManagedVirtualNetworkName	The managed virtual network name. It is restricted to the value 'defaultv2' for now.

ConnectionStateProperties

Object

The properties of connection state.

Name	Type	Description
actionsRequired	string	ActionsRequired for a private link connection.
description	string	Description of a private link connection.
status	string	Status of a private link connection.

ErrorModel

Object

The error model.

Name	Type	Description
code	string	A unique error code that identifies the specific error.
details	ErrorModel[]	An array of nested ErrorModel objects that provides additional error details.
message	string	A human-readable error message that provides more details about the error.
target	string	The specific component that the error is associated with.

ErrorResponseModel

Object

The error response model.

Name	Type	Description
error	ErrorModel	The error model.

ManagedPrivateEndpoint

Object

The managed private endpoint.

Name	Type	Description
id	string	The resource identifier.
name	string	The resource name.
properties	ManagedPrivateEndpointProperties	The properties of managed private endpoint.

ManagedPrivateEndpointProperties

Object

The properties of managed private endpoint.

Name	Type	Description
connectionState	ConnectionStateProperties	The properties of connection state.
fqdns	string[]	The fqdns of managed private endpoint.
groupId	string	The group identifier of managed private endpoint.
privateLinkResourceId	string	The private link resource identifier of managed private endpoint.
provisioningState	string	The provisioning state of managed private endpoint.

ManagedVirtualNetworkName

Enumeration

The managed virtual network name. It is restricted to the value 'defaultv2' for now.

Value	Description
defaultv2