你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Instance Pools - Get

服务:: SQL Database

API 版本:: 2023-08-01

获取实例池。

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

URI 参数

名称	在	必需	类型	说明
instancePoolName	path	True	string	要检索的实例池的名称。
resourceGroupName	path	True	string	包含资源的资源组的名称。可以从 Azure 资源管理器 API 或门户获取此值。
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。

响应

名称	类型	说明
200 OK	InstancePool	已成功检索指定的实例池。
Other Status Codes	ErrorResponse	错误响应： *** 400 MismatchingResourceGroupNameWithUrl - 提供的资源组名称与 URL 中的名称不匹配。 400 MismatchingSubscriptionWithUrl - 提供的订阅与 URL 中的订阅不匹配。 400 InvalidMinimalTlsVersion - 最低 TLS 版本无效。 400 InvalidResourceId - 资源标识符无效。 400 InvalidParameterValue - 为参数提供无效值。 400 DeleteOfManagedInstanceIsDisabled - 禁用托管实例的删除作。 400 CustomMaintenanceWindowIsDisabled - 未启用自定义维护时段。 400 MICantBeMovedFromOrToInstancePool - 无法将现有托管实例移动到托管实例池。 404 SubscriptionNotFound - 找不到请求的订阅。 404 InstancePoolNotFound - 找不到实例池 429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。 503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。

名称

类型

说明

200 OK

InstancePool

已成功检索指定的实例池。

Other Status Codes

ErrorResponse

错误响应： ***

400 MismatchingResourceGroupNameWithUrl - 提供的资源组名称与 URL 中的名称不匹配。
400 MismatchingSubscriptionWithUrl - 提供的订阅与 URL 中的订阅不匹配。
400 InvalidMinimalTlsVersion - 最低 TLS 版本无效。
400 InvalidResourceId - 资源标识符无效。
400 InvalidParameterValue - 为参数提供无效值。
400 DeleteOfManagedInstanceIsDisabled - 禁用托管实例的删除作。
400 CustomMaintenanceWindowIsDisabled - 未启用自定义维护时段。
400 MICantBeMovedFromOrToInstancePool - 无法将现有托管实例移动到托管实例池。
404 SubscriptionNotFound - 找不到请求的订阅。
404 InstancePoolNotFound - 找不到实例池
429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。
503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。

示例

Get an instance pool

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP?api-version=2023-08-01

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/GetInstancePool.json
// this example is just showing the usage of "InstancePools_Get" 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://free.blessedness.top/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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this InstancePoolResource
InstancePoolCollection collection = resourceGroupResource.GetInstancePools();

// invoke the operation
string instancePoolName = "testIP";
NullableResponse<InstancePoolResource> response = await collection.GetIfExistsAsync(instancePoolName);
InstancePoolResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result 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
    InstancePoolData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

示例响应

状态代码:: 200

{
  "sku": {
    "name": "GP_Gen5",
    "tier": "GeneralPurpose",
    "family": "Gen5"
  },
  "properties": {
    "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetwork/myvnet/subnets/mysubnet1",
    "vCores": 8,
    "licenseType": "LicenseIncluded",
    "dnsZone": "1234567890",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1"
  },
  "location": "japaneast",
  "tags": {
    "a": "b"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP",
  "name": "testIP",
  "type": "Microsoft.Sql/instancePools"
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
InstancePool	Azure SQL 实例池。
InstancePoolLicenseType	许可证类型。可能的值为“LicenseIncluded”（包括 SQL 许可证的价格）和“BasePrice”（不含 SQL 许可证价格）。
Sku	ARM 资源 SKU。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

InstancePool

Object

Azure SQL 实例池。

名称	类型	说明
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.dnsZone	string	托管实例池位于的 Dns 区域。
properties.licenseType	InstancePoolLicenseType	许可证类型。可能的值为“LicenseIncluded”（包括 SQL 许可证的价格）和“BasePrice”（不含 SQL 许可证价格）。
properties.maintenanceConfigurationId	string (arm-id)	指定要应用于此托管实例的维护配置 ID。
properties.subnetId	string	要在其中放置此实例池的子网的资源 ID。
properties.vCores	integer (int32)	属于此实例池的 vCore 计数。
sku	Sku	SKU 的名称和层。
tags	object	资源标记。
type	string	资源类型。

InstancePoolLicenseType

枚举

许可证类型。可能的值为“LicenseIncluded”（包括 SQL 许可证的价格）和“BasePrice”（不含 SQL 许可证价格）。

值	说明
LicenseIncluded
BasePrice

Sku

Object

ARM 资源 SKU。

名称	类型	说明
capacity	integer (int32)	特定 SKU 的容量。
family	string	如果服务具有不同代的硬件（对于同一 SKU，则可以在此处捕获）。
name	string	SKU 的名称，通常为字母 + 数字代码，例如 P3。
size	string	特定 SKU 的大小
tier	string	特定 SKU 的层或版本，例如基本 SKU、高级版。

通过

Instance Pools - Get

URI 参数

响应

示例

Get an instance pool

示例请求

示例响应

定义

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InstancePool

InstancePoolLicenseType

Sku