Web Apps - Get Private Endpoint Connection Slot

Referenz

Service:: App Service

API Version:: 2023-12-01

Beschreibung für Ruft eine verbindung mit einem privaten Endpunkt ab

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Name der Website.
privateEndpointConnectionName	path	True	string	Name der Verbindung mit dem privaten Endpunkt.
resourceGroupName	path	True	string	Name der Ressourcengruppe, zu der die Ressource gehört. Regex pattern: `^[-\w\._]+[^\.]$`
slot	path	True	string	Name des Standortbereitstellungsslots.
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 00000000-0000-0000-0000-00000000000000).
api-version	query	True	string	API-Version

Antworten

Name	Typ	Beschreibung
200 OK	RemotePrivateEndpointConnectionARMResource	OK
Other Status Codes	DefaultErrorResponse	App Service Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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=2023-12-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": ""
    }
  }
}

Definitionen

Name	Beschreibung
ArmIdWrapper	Ein Wrapper für eine ARM-Ressourcen-ID
DefaultErrorResponse	App Service Fehlerantwort.
Details
Error	Fehlermodell.
PrivateLinkConnectionState	Der Zustand einer Verbindung mit privatem Link
RemotePrivateEndpointConnectionARMResource	ARM-Ressource für private Remoteendpunkteverbindung.

ArmIdWrapper

Ein Wrapper für eine ARM-Ressourcen-ID

Name	Typ	Beschreibung
id	string

DefaultErrorResponse

App Service Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Error

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen eines Fehlers.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

PrivateLinkConnectionState

Der Zustand einer Verbindung mit privatem Link

Name	Typ	Beschreibung
actionsRequired	string	ActionsRequired for a private link connection
description	string	Beschreibung einer Verbindung mit privatem Link
status	string	Status einer Verbindung mit privatem Link

RemotePrivateEndpointConnectionARMResource

ARM-Ressource für private Remoteendpunkteverbindung.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Ressource.
name	string	Ressourcenname.
properties.ipAddresses	string[]	Private IPAddresses, die dem privaten Remoteendpunkt zugeordnet sind
properties.privateEndpoint	ArmIdWrapper	PrivateEndpoint einer privaten Remoteendpunkt-Endpunktverbindung
properties.privateLinkServiceConnectionState	PrivateLinkConnectionState	Der Zustand einer Verbindung mit privatem Link
properties.provisioningState	string
type	string	Der Ressourcentyp.

Share via