Web Apps - Get Private Link Resources

Service:

App Service

API Version:

2023-12-01

Beschreibung für Ruft die Private Link-Ressourcen ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Name der Website.
resourceGroupName	path	True	string	Name der Ressourcengruppe, zu der die Ressource gehört. Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-00000000000000000).
api-version	query	True	string	API-Version

Antworten

Name	Typ	Beschreibung
200 OK	PrivateLinkResourcesWrapper	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 private link resources of a site

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateLinkResources?api-version=2023-12-01

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateLinkResources/site",
      "name": "site",
      "type": "Microsoft.Web/sites/privateLinkResources",
      "properties": {
        "groupId": "sites",
        "requiredMembers": [
          "sites"
        ],
        "requiredZoneNames": [
          "privatelink.testsite.azurewebsites.net"
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
DefaultErrorResponse	App Service Fehlerantwort.
Details
Error	Fehlermodell.
PrivateLinkResource	Eine Private Link-Ressource
PrivateLinkResourceProperties	Eigenschaften einer Private Link-Ressource
PrivateLinkResourcesWrapper	Wrapper für eine Sammlung von Private Link-Ressourcen

DefaultErrorResponse

App Service Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.
message	string	Ausführliche Fehlerbeschreibung und Debuginformationen.
target	string	Ausführliche Fehlerbeschreibung und Debuginformationen.

Error

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen des Fehlers.
message	string	Ausführliche Fehlerbeschreibung und Debuginformationen.
target	string	Ausführliche Fehlerbeschreibung und Debuginformationen.

PrivateLinkResource

Eine Private Link-Ressource

Name	Typ	Beschreibung
id	string
name	string	Name einer Private Link-Ressource
properties	PrivateLinkResourceProperties	Eigenschaften einer Private Link-Ressource
type	string

PrivateLinkResourceProperties

Eigenschaften einer Private Link-Ressource

Name	Typ	Beschreibung
groupId	string	GroupId einer Private Link-Ressource
requiredMembers	string[]	RequiredMembers einer Private Link-Ressource
requiredZoneNames	string[]	RequiredZoneNames einer Private Link-Ressource

PrivateLinkResourcesWrapper

Wrapper für eine Sammlung von Private Link-Ressourcen

Name	Typ	Beschreibung
value	PrivateLinkResource[]	Eine Private Link-Ressource