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 Resource Manager 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 - 使用可能なリソースによって処理できる最大要求を超える要求。

例

Get an instance pool

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP?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.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://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 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)	このインスタンス プールに属する仮想コアの数。
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 のレベルまたはエディション (Basic、Premium など)。