Dela via


Private Endpoints - PrivateEndpointConnections Get

Get private endpoint connection properties for the given private endpoint.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2023-01-31

URI Parameters

Name In Required Type Description
privateEndpointConnectionName
path True

string

The name of the private endpoint connection.

resourceGroupName
path True

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName
path True

string

The name of the DigitalTwinsInstance.

Regex pattern: ^(?!-)[A-Za-z0-9-]{3,63}(?<!-)$

subscriptionId
path True

string

The subscription identifier.

api-version
query True

string

Version of the DigitalTwinsInstance Management API.

Responses

Name Type Description
200 OK

PrivateEndpointConnection

The body contains the private endpoint connection properties.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

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

Get private endpoint connection properties for the given private endpoint

Sample request

GET https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/privateEndpointConnections/myPrivateConnection?api-version=2023-01-31

Sample response

{
  "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/privateEndpointConnections/myPrivateConnection",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/resRg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
    },
    "groupIds": [
      "digitalTwinsInstance"
    ],
    "privateLinkServiceConnectionState": {
      "status": "Pending",
      "description": "Please approve my request, thanks.",
      "actionsRequired": "None"
    }
  }
}

Definitions

Name Description
ConnectionProperties

The properties of a private endpoint connection.

ConnectionPropertiesProvisioningState

The provisioning state.

createdByType

The type of identity that created the resource.

ErrorDefinition

Error definition.

ErrorResponse

Error response.

PrivateEndpoint

The private endpoint property of a private endpoint connection.

PrivateEndpointConnection

The private endpoint connection of a Digital Twin.

PrivateLinkServiceConnectionState

The connection state.

PrivateLinkServiceConnectionStatus

The status of a private endpoint connection.

SystemData

Metadata pertaining to creation and last modification of the resource.

ConnectionProperties

The properties of a private endpoint connection.

Name Type Description
groupIds

string[]

The list of group ids for the private endpoint connection.

privateEndpoint

PrivateEndpoint

The private endpoint.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

The connection state.

provisioningState

ConnectionPropertiesProvisioningState

The provisioning state.

ConnectionPropertiesProvisioningState

The provisioning state.

Name Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDefinition

Error definition.

Name Type Description
code

string

Service specific error code which serves as the substatus for the HTTP error code.

details

ErrorDefinition[]

Internal error details.

message

string

Description of the error.

ErrorResponse

Error response.

Name Type Description
error

ErrorDefinition

Error description

PrivateEndpoint

The private endpoint property of a private endpoint connection.

Name Type Description
id

string

The resource identifier.

PrivateEndpointConnection

The private endpoint connection of a Digital Twin.

Name Type Description
id

string

The resource identifier.

name

string

The resource name.

properties

ConnectionProperties

The connection properties.

systemData

SystemData

Metadata pertaining to creation and last modification of the private endpoint connection.

type

string

The resource type.

PrivateLinkServiceConnectionState

The connection state.

Name Type Description
actionsRequired

string

Actions required for a private endpoint connection.

description

string

The description for the current state of a private endpoint connection.

status

PrivateLinkServiceConnectionStatus

The status of a private endpoint connection.

PrivateLinkServiceConnectionStatus

The status of a private endpoint connection.

Name Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

SystemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.