Web Apps - Get Private Endpoint Connection Slot

Reference

Service:: App Service

API Version:: 2024-04-01

Description for Gets a private endpoint connection

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the site.
privateEndpointConnectionName	path	True	string	Name of the private endpoint connection.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: `^[-\w\._]+[^\.]$`
slot	path	True	string	Name of the site deployment slot.
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	RemotePrivateEndpointConnectionARMResource	OK
Other Status Codes	DefaultErrorResponse	App Service error response.

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 a private endpoint connection for a site.

Sample request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/privateEndpointConnections/connection?api-version=2024-04-01

Sample response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slot/stage/privateEndpointConnections/connection",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by admin.",
      "actionsRequired": ""
    }
  }
}

Definitions

Name	Description
ArmIdWrapper	A wrapper for an ARM resource id
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
PrivateLinkConnectionState	The state of a private link connection
RemotePrivateEndpointConnectionARMResource	Remote Private Endpoint Connection ARM resource.

ArmIdWrapper

A wrapper for an ARM resource id

Name	Type	Description
id	string

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

PrivateLinkConnectionState

The state of a private link connection

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

RemotePrivateEndpointConnectionARMResource

Remote Private Endpoint Connection ARM resource.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.ipAddresses	string[]	Private IPAddresses mapped to the remote private endpoint
properties.privateEndpoint	ArmIdWrapper	PrivateEndpoint of a remote private endpoint connection
properties.privateLinkServiceConnectionState	PrivateLinkConnectionState	The state of a private link connection
properties.provisioningState	string
type	string	Resource type.

Share via