Private Link Resources - List By Server

服務:

SQL Database

API 版本:

2023-08-01

取得 SQL Server 的私人鏈接資源。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/privateLinkResources?api-version=2023-08-01

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	包含資源的資源群組名稱。 您可以從 Azure Resource Manager API 或入口網站取得此值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	識別 Azure 訂用帳戶的訂用帳戶標識碼。
api-version	query	True	string	要用於要求的 API 版本。

回應

名稱	類型	Description
200 OK	PrivateLinkResourceListResult	已成功擷取私人鏈接資源。
Other Status Codes	ErrorResponse	錯誤回應： *** 400 InvalidServerName - 指定的伺服器名稱無效。 400 InvalidIdentifier - 識別碼包含 NULL 或無效的 Unicode 字元。 400 TokenTooLong - 提供的令牌太長。 404 OperationIdNotFound - 標識符為 的作業不存在。 404 OperationIdNotFound - 標識符為 的作業不存在。 409 CannotCancelOperation - 管理作業處於無法取消的狀態。 409 OperationCancelled - 使用者已取消作業。 409 OperationInterrupted - 無法完成資源上的作業，因為相同資源上的另一個作業中斷。 429 SubscriptionTooManyCreateUpdateRequests - 超出可用資源可處理之最大要求的要求。 429 SubscriptionTooManyRequests - 超出可用資源可處理之最大要求的要求。 500 OperationTimedOut - 作業逾時並自動回復。 請重試作業。 503 TooManyRequests - 超出可用資源可處理之最大要求的要求。

範例

Gets private link resources for SQL.

範例要求

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateLinkResources?api-version=2023-08-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/PrivateLinkResourcesList.json
// this example is just showing the usage of "PrivateLinkResources_ListByServer" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "test-svr";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlPrivateLinkResource
SqlPrivateLinkResourceCollection collection = sqlServer.GetSqlPrivateLinkResources();

// invoke the operation and iterate over the result
await foreach (SqlPrivateLinkResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SqlPrivateLinkResourceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:

200

{
  "value": [
    {
      "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateLinkResources/plr",
      "name": "plr",
      "type": "Microsoft.Sql/servers/privateLinkResources",
      "properties": {
        "groupId": "sqlServer",
        "requiredMembers": [
          "sqlServer"
        ]
      }
    }
  ]
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
PrivateLinkResource	私人鏈接資源
PrivateLinkResourceListResult	私人鏈接資源清單
PrivateLinkResourceProperties	私人鏈接資源的屬性。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

PrivateLinkResource

Object

私人鏈接資源

名稱	類型	Description
id	string	資源標識碼。
name	string	資源名稱。
properties	PrivateLinkResourceProperties	私人鏈接資源群組識別碼。
type	string	資源類型。

PrivateLinkResourceListResult

Object

私人鏈接資源清單

名稱	類型	Description
nextLink	string	連結以擷取下一頁的結果。
value	PrivateLinkResource[]	結果的陣列。

PrivateLinkResourceProperties

Object

私人鏈接資源的屬性。

名稱	類型	Description
groupId	string	私人鏈接資源群組識別碼。
requiredMembers	string[]	私人鏈接資源所需的成員名稱。
requiredZoneNames	string[]	私人鏈接資源所需的區域名稱。