Instance Pools - List

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

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

URI パラメーター

名前 / 必須 型 説明
subscriptionId
path True

string (uuid)

ターゲット サブスクリプションの ID。 値は UUID である必要があります。

api-version
query True

string

minLength: 1

この操作に使用する API バージョン。

応答

名前 型 説明
200 OK

InstancePoolListResult

Azureの運用は無事に完了しました。

Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

例

List instance pools in the subscription

要求のサンプル

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

応答のサンプル

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

定義

名前 説明
createdByType

リソースを作成した ID の種類。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

InstancePool

An Azure SQL instance pool.

InstancePoolLicenseType

ライセンスの種類。 指定できる値は、'LicenseIncluded' (SQL ライセンスの価格が含まれています) と 'BasePrice' (SQL ライセンス価格なし) です。

InstancePoolListResult

InstancePoolのリスト操作の応答。

Sku

ARM リソース SKU。

systemData

リソースの作成と最後の変更に関連するメタデータ。

createdByType

リソースを作成した ID の種類。

値 説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 型 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorResponse

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

InstancePool

An Azure SQL instance pool.

名前 型 説明
id

string (arm-id)

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

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 の名前と層。

systemData

systemData

create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。

tags

object

リソース タグ。

type

string

リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

InstancePoolLicenseType

ライセンスの種類。 指定できる値は、'LicenseIncluded' (SQL ライセンスの価格が含まれています) と 'BasePrice' (SQL ライセンス価格なし) です。

値 説明
LicenseIncluded

ライセンス含録

BasePrice

BasePrice

InstancePoolListResult

InstancePoolのリスト操作の応答。

名前 型 説明
nextLink

string (uri)

項目の次のページへのリンク

value

InstancePool[]

このページのInstancePool項目

Sku

ARM リソース SKU。

名前 型 説明
capacity

integer (int32)

特定の SKU の容量。

family

string

同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。

name

string

SKU の名前 。通常は、文字 + 番号コード (P3 など)。

size

string

特定の SKU のサイズ

tier

string

特定の SKU のレベルまたはエディション (Basic、Premium など)。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 型 説明
createdAt

string (date-time)

リソース作成のタイムスタンプ (UTC)。

createdBy

string

リソースを作成した ID。

createdByType

createdByType

リソースを作成した ID の種類。

lastModifiedAt

string (date-time)

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy

string

リソースを最後に変更した ID。

lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。