Web Apps - Get Private Link Resources
Description for Gets the private link resources
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateLinkResources?api-version=2024-04-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
name
|
path | True |
string |
Name of the site. |
resource
|
path | True |
string |
Name of the resource group to which the resource belongs. Regex pattern: |
subscription
|
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 |
OK |
|
Other Status Codes |
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 private link resources of a site
Sample request
Sample response
{
"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"
]
}
}
]
}
Definitions
Name | Description |
---|---|
Default |
App Service error response. |
Details | |
Error |
Error model. |
Private |
A private link resource |
Private |
Properties of a private link resource |
Private |
Wrapper for a collection of private link resources |
DefaultErrorResponse
App Service error response.
Name | Type | Description |
---|---|---|
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. |
PrivateLinkResource
A private link resource
Name | Type | Description |
---|---|---|
id |
string |
|
name |
string |
Name of a private link resource |
properties |
Properties of a private link resource |
|
type |
string |
PrivateLinkResourceProperties
Properties of a private link resource
Name | Type | Description |
---|---|---|
groupId |
string |
GroupId of a private link resource |
requiredMembers |
string[] |
RequiredMembers of a private link resource |
requiredZoneNames |
string[] |
RequiredZoneNames of a private link resource |
PrivateLinkResourcesWrapper
Wrapper for a collection of private link resources
Name | Type | Description |
---|---|---|
value |
A private link resource |