Instance Pools - List

サービス:: SQL Database

API バージョン:: 2023-08-01

サブスクリプション内のすべてのインスタンスプールの一覧を取得します。

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

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求に使用する API バージョン。

応答

名前	型	説明
200 OK	InstancePoolListResult	サブスクリプション内のインスタンスプールの一覧を正常に取得しました。
Other Status Codes	ErrorResponse	エラー応答: *** 404 SubscriptionNotFound - 要求されたサブスクリプションが見つかりませんでした。 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

名前

型

説明

200 OK

InstancePoolListResult

サブスクリプション内のインスタンスプールの一覧を正常に取得しました。

Other Status Codes

ErrorResponse

エラー応答: ***

404 SubscriptionNotFound - 要求されたサブスクリプションが見つかりませんでした。
429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。
503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

例

List instance pools in the subscription

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/instancePools?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.Resources.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ListInstancePoolsBySubscriptionId.json
// this example is just showing the usage of "InstancePools_List" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (InstancePoolResource item in subscriptionResource.GetInstancePoolsAsync())
{
    // 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
    InstancePoolData 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": [
    {
      "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"
    },
    {
      "sku": {
        "name": "GP_Gen5",
        "tier": "GeneralPurpose",
        "family": "Gen5"
      },
      "properties": {
        "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group2/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/group2/providers/Microsoft.Sql/instancePools/testIP2",
      "name": "testIP2",
      "type": "Microsoft.Sql/instancePools"
    }
  ]
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
InstancePool	Azure SQL インスタンスプール。
InstancePoolLicenseType	ライセンスの種類。指定できる値は、'LicenseIncluded' (SQL ライセンスの価格が含まれています) と 'BasePrice' (SQL ライセンス価格なし) です。
InstancePoolListResult	Azure 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

InstancePoolListResult

Object

Azure SQL インスタンスプールの一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	InstancePool[]	結果の配列。

Sku

Object

ARM リソース SKU。

名前	型	説明
capacity	integer (int32)	特定の SKU の容量。
family	string	同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。
name	string	SKU の名前。通常は、文字 + 番号コード (P3 など)。
size	string	特定の SKU のサイズ
tier	string	特定の SKU のレベルまたはエディション (Basic、Premium など)。

次の方法で共有

Instance Pools - List

URI パラメーター

応答

例

List instance pools in the subscription

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InstancePool

InstancePoolLicenseType

InstancePoolListResult

Sku