Databases - List By Elastic Pool

リファレンス

サービス:: SQL Database

API バージョン:: 2021-11-01

エラスティックプール内のデータベースの一覧を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}/databases?api-version=2021-11-01

URI パラメーター

名前	/	必須	型	説明
elasticPoolName	path	True	string	エラスティックプールの名前。
resourceGroupName	path	True	string	リソースを含むリソースグループの名前。この値は、Azure Resource Manager API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求に使用する API バージョン。

応答

名前	型	説明
200 OK	DatabaseListResult	エラスティックプール内のデータベースの一覧を正常に取得しました。
Other Status Codes		エラー応答: *** 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。 404 CannotFindObject - オブジェクトが存在しないか、アクセス許可がないため、オブジェクトが見つかりません 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。 404 ServerNotInSubscription - 指定されたサーバーが指定されたサブスクリプションに存在しません。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 504 RequestTimeout - サービス要求が許可されたタイムアウトを超えました。

名前

型

説明

200 OK

DatabaseListResult

エラスティックプール内のデータベースの一覧を正常に取得しました。

Other Status Codes

エラー応答: ***

404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。
404 CannotFindObject - オブジェクトが存在しないか、アクセス許可がないため、オブジェクトが見つかりません
404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。
404 ServerNotInSubscription - 指定されたサーバーが指定されたサブスクリプションに存在しません。
429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求を超える要求。
429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。
503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。
504 RequestTimeout - サービス要求が許可されたタイムアウトを超えました。

例

Gets a list of databases in an elastic pool.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/elasticPools/pool1/databases?api-version=2021-11-01


/**
 * Samples for Databases ListByElasticPool.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListDatabasesByElasticPool.json
     */
    /**
     * Sample code: Gets a list of databases in an elastic pool.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsAListOfDatabasesInAnElasticPool(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabases().listByElasticPool("Default-SQL-SouthEastAsia",
            "testsvr", "pool1", com.azure.core.util.Context.NONE);
    }
}

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": "ElasticPool",
        "tier": "Standard"
      },
      "kind": "v12.0,user",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 268435456000,
        "elasticPoolId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/elasticPools/Pool1",
        "status": "Online",
        "databaseId": "bfe0735f-bc87-447f-b2c2-481f4b100614",
        "creationDate": "2017-07-12T22:08:39.163Z",
        "currentServiceObjectiveName": "ElasticPool",
        "defaultSecondaryLocation": "North Europe",
        "catalogCollation": "SQL_Latin1_General_CP1_CI_AS"
      },
      "location": "southeastasia",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/DB001",
      "name": "DB001",
      "type": "Microsoft.Sql/servers/databases"
    },
    {
      "sku": {
        "name": "ElasticPool",
        "tier": "Standard"
      },
      "kind": "v12.0,user",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 268435456000,
        "elasticPoolId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/elasticPools/Pool1",
        "status": "Online",
        "databaseId": "82246152-3177-4357-b81c-a16d87ce3593",
        "creationDate": "2017-07-12T22:10:10.773Z",
        "currentServiceObjectiveName": "ElasticPool",
        "defaultSecondaryLocation": "North Europe",
        "catalogCollation": "SQL_Latin1_General_CP1_CI_AS"
      },
      "location": "southeastasia",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/DB002",
      "name": "DB002",
      "type": "Microsoft.Sql/servers/databases"
    }
  ]
}

定義

名前	説明
BackupStorageRedundancy	このデータベースのバックアップを格納するために使用されるストレージアカウントの種類。
CatalogCollationType	メタデータカタログの照合順序。
CreateMode	データベースの作成モードを指定します。既定値: 通常のデータベース作成。コピー: 既存のデータベースのコピーとしてデータベースを作成します。 sourceDatabaseId は、ソースデータベースのリソース ID として指定する必要があります。セカンダリ: 既存のデータベースのセカンダリレプリカとしてデータベースを作成します。 sourceDatabaseId は、既存のプライマリデータベースのリソース ID として指定する必要があります。 PointInTimeRestore: 既存のデータベースの特定の時点のバックアップを復元してデータベースを作成します。 sourceDatabaseId を既存のデータベースのリソース ID として指定し、restorePointInTime を指定する必要があります。復旧: geo レプリケートされたバックアップを復元してデータベースを作成します。 sourceDatabaseId は、復元する回復可能なデータベースリソース ID として指定する必要があります。復元: 削除されたデータベースのバックアップを復元してデータベースを作成します。 sourceDatabaseId を指定する必要があります。 sourceDatabaseId がデータベースの元のリソース ID である場合は、sourceDatabaseDeletionDate を指定する必要があります。それ以外の場合、sourceDatabaseId は復元可能な破棄されたデータベースリソース ID である必要があり、sourceDatabaseDeletionDate は無視されます。 restorePointInTime は、以前の時点から復元するように指定することもできます。 RestoreLongTermRetentionBackup: 長期保持コンテナーから復元することでデータベースを作成します。 recoveryServicesRecoveryPointResourceId は、復旧ポイントのリソース ID として指定する必要があります。 DataWarehouse エディションでは、コピー、セカンダリ、RestoreLongTermRetentionBackup はサポートされていません。
Database	データベースリソース。
DatabaseIdentity	リソースの Azure Active Directory ID 構成。
DatabaseIdentityType	ID の種類
DatabaseLicenseType	このデータベースに適用するライセンスの種類。ライセンスが必要な場合は `LicenseIncluded`、ライセンスを所有していて Azure ハイブリッド特典の対象となる場合は `BasePrice` します。
DatabaseListResult	データベースの一覧。
DatabaseReadScale	読み取り専用ルーティングの状態。有効にした場合、アプリケーションの意図が接続文字列で読み取り専用に設定されている接続は、同じリージョンの読み取り専用セカンダリレプリカにルーティングされる可能性があります。エラスティックプール内の Hyperscale データベースには適用されません。
DatabaseStatus	データベースの状態。
DatabaseUserIdentity	リソースの Azure Active Directory ID 構成。
SampleName	このデータベースの作成時に適用するサンプルスキーマの名前。
SecondaryType	データベースがセカンダリの場合は、そのセカンダリの種類。有効な値は Geo と Named です。
Sku	ARM リソース SKU。

BackupStorageRedundancy

列挙

このデータベースのバックアップを格納するために使用されるストレージアカウントの種類。

値	説明
Geo
GeoZone
Local
Zone

CatalogCollationType

列挙

メタデータカタログの照合順序。

値	説明
DATABASE_DEFAULT
SQL_Latin1_General_CP1_CI_AS

CreateMode

列挙

データベースの作成モードを指定します。

既定値: 通常のデータベース作成。

コピー: 既存のデータベースのコピーとしてデータベースを作成します。 sourceDatabaseId は、ソースデータベースのリソース ID として指定する必要があります。

セカンダリ: 既存のデータベースのセカンダリレプリカとしてデータベースを作成します。 sourceDatabaseId は、既存のプライマリデータベースのリソース ID として指定する必要があります。

PointInTimeRestore: 既存のデータベースの特定の時点のバックアップを復元してデータベースを作成します。 sourceDatabaseId を既存のデータベースのリソース ID として指定し、restorePointInTime を指定する必要があります。

復旧: geo レプリケートされたバックアップを復元してデータベースを作成します。 sourceDatabaseId は、復元する回復可能なデータベースリソース ID として指定する必要があります。

復元: 削除されたデータベースのバックアップを復元してデータベースを作成します。 sourceDatabaseId を指定する必要があります。 sourceDatabaseId がデータベースの元のリソース ID である場合は、sourceDatabaseDeletionDate を指定する必要があります。それ以外の場合、sourceDatabaseId は復元可能な破棄されたデータベースリソース ID である必要があり、sourceDatabaseDeletionDate は無視されます。 restorePointInTime は、以前の時点から復元するように指定することもできます。

RestoreLongTermRetentionBackup: 長期保持コンテナーから復元することでデータベースを作成します。 recoveryServicesRecoveryPointResourceId は、復旧ポイントのリソース ID として指定する必要があります。

DataWarehouse エディションでは、コピー、セカンダリ、RestoreLongTermRetentionBackup はサポートされていません。

値	説明
Copy
Default
OnlineSecondary
PointInTimeRestore
Recovery
Restore
RestoreExternalBackup
RestoreExternalBackupSecondary
RestoreLongTermRetentionBackup
Secondary

Database

Object

データベースリソース。

名前	型	説明
id	string	リソース ID。
identity	DatabaseIdentity	データベースの Azure Active Directory ID。
kind	string	データベースの種類。これは、Azure portal エクスペリエンスに使用されるメタデータです。
location	string	リソースの場所。
managedBy	string	データベースを管理するリソース。
name	string	リソース名。
properties.autoPauseDelay	integer (int32)	データベースが自動的に一時停止されるまでの時間 (分)。 -1 の値は、自動一時停止が無効になっていることを意味します
properties.catalogCollation	CatalogCollationType	メタデータカタログの照合順序。
properties.collation	string	データベースの照合順序。
properties.createMode	CreateMode	データベースの作成モードを指定します。既定値: 通常のデータベース作成。コピー: 既存のデータベースのコピーとしてデータベースを作成します。 sourceDatabaseId は、ソースデータベースのリソース ID として指定する必要があります。セカンダリ: 既存のデータベースのセカンダリレプリカとしてデータベースを作成します。 sourceDatabaseId は、既存のプライマリデータベースのリソース ID として指定する必要があります。 PointInTimeRestore: 既存のデータベースの特定の時点のバックアップを復元してデータベースを作成します。 sourceDatabaseId を既存のデータベースのリソース ID として指定し、restorePointInTime を指定する必要があります。復旧: geo レプリケートされたバックアップを復元してデータベースを作成します。 sourceDatabaseId は、復元する回復可能なデータベースリソース ID として指定する必要があります。復元: 削除されたデータベースのバックアップを復元してデータベースを作成します。 sourceDatabaseId を指定する必要があります。 sourceDatabaseId がデータベースの元のリソース ID である場合は、sourceDatabaseDeletionDate を指定する必要があります。それ以外の場合、sourceDatabaseId は復元可能な破棄されたデータベースリソース ID である必要があり、sourceDatabaseDeletionDate は無視されます。 restorePointInTime は、以前の時点から復元するように指定することもできます。 RestoreLongTermRetentionBackup: 長期保持コンテナーから復元することでデータベースを作成します。 recoveryServicesRecoveryPointResourceId は、復旧ポイントのリソース ID として指定する必要があります。 DataWarehouse エディションでは、コピー、セカンダリ、RestoreLongTermRetentionBackup はサポートされていません。
properties.creationDate	string (date-time)	データベースの作成日 (ISO8601形式)。
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	このデータベースのバックアップを格納するために使用されるストレージアカウントの種類。
properties.currentServiceObjectiveName	string	データベースの現在のサービスレベル目標名。
properties.currentSku	Sku	SKU の名前と層。
properties.databaseId	string (uuid)	データベースの ID。
properties.defaultSecondaryLocation	string	このデータベースの既定のセカンダリリージョン。
properties.earliestRestoreDate	string (date-time)	これにより、このデータベースに対して復元が使用できる最も早い開始日と時刻が記録されます (ISO8601形式)。
properties.elasticPoolId	string (arm-id)	このデータベースを含むエラスティックプールのリソース識別子。
properties.failoverGroupId	string	このデータベースが属しているフェールオーバーグループリソース識別子。
properties.federatedClientId	string (uuid)	データベース CMK ごとのテナント間のシナリオに使用されるクライアント ID
properties.highAvailabilityReplicaCount	integer (int32)	高可用性を提供するために使用されるデータベースに関連付けられているセカンダリレプリカの数。エラスティックプール内の Hyperscale データベースには適用されません。
properties.isInfraEncryptionEnabled	boolean	このデータベースに対して Infra 暗号化が有効になっています。
properties.isLedgerOn	boolean	このデータベースが台帳データベースであるかどうかは、データベース内のすべてのテーブルが台帳テーブルであることを意味します。注: このプロパティの値は、データベースの作成後は変更できません。
properties.licenseType	DatabaseLicenseType	このデータベースに適用するライセンスの種類。ライセンスが必要な場合は `LicenseIncluded`、ライセンスを所有していて Azure ハイブリッド特典の対象となる場合は `BasePrice` します。
properties.longTermRetentionBackupResourceId	string (arm-id)	このデータベースの作成操作に関連付けられている長期保有バックアップのリソース識別子。
properties.maintenanceConfigurationId	string	データベースに割り当てられたメンテナンス構成 ID。この構成では、メンテナンスの更新が行われる期間を定義します。
properties.maxLogSizeBytes	integer (int64)	このデータベースの最大ログサイズ。
properties.maxSizeBytes	integer (int64)	バイト単位で表されるデータベースの最大サイズ。
properties.minCapacity	number (double)	一時停止されていない場合、データベースが常に割り当てる最小限の容量
properties.pausedDate	string (date-time)	ユーザー構成またはアクション (ISO8601形式) によってデータベースが一時停止された日付。データベースの準備ができた場合は Null。
properties.readScale	DatabaseReadScale	読み取り専用ルーティングの状態。有効にした場合、アプリケーションの意図が接続文字列で読み取り専用に設定されている接続は、同じリージョンの読み取り専用セカンダリレプリカにルーティングされる可能性があります。エラスティックプール内の Hyperscale データベースには適用されません。
properties.recoverableDatabaseId	string (arm-id)	このデータベースの作成操作に関連付けられている回復可能なデータベースのリソース識別子。
properties.recoveryServicesRecoveryPointId	string (arm-id)	このデータベースの作成操作に関連付けられている復旧ポイントのリソース識別子。
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	このデータベースのバックアップを格納するために使用するストレージアカウントの種類。
properties.requestedServiceObjectiveName	string	データベースの要求されたサービスレベル目標名。
properties.restorableDroppedDatabaseId	string (arm-id)	このデータベースの作成操作に関連付けられている、復元可能な削除されたデータベースのリソース識別子。
properties.restorePointInTime	string (date-time)	新しいデータベースを作成するために復元されるソースデータベースの時点 (ISO8601形式) を指定します。
properties.resumedDate	string (date-time)	ユーザーアクションまたはデータベースログイン (ISO8601形式) によってデータベースが再開された日付。データベースが一時停止されている場合は Null。
properties.sampleName	SampleName	このデータベースの作成時に適用するサンプルスキーマの名前。
properties.secondaryType	SecondaryType	データベースがセカンダリの場合は、そのセカンダリの種類。有効な値は Geo と Named です。
properties.sourceDatabaseDeletionDate	string (date-time)	データベースが削除された時刻を指定します。
properties.sourceDatabaseId	string (arm-id)	このデータベースの作成操作に関連付けられているソースデータベースのリソース識別子。
properties.sourceResourceId	string (arm-id)	このデータベースの作成操作に関連付けられているソースのリソース識別子。このプロパティは DataWarehouse エディションでのみサポートされており、サブスクリプション間で復元できます。 sourceResourceId が指定されている場合、sourceDatabaseId、recoverableDatabaseId、restorableDroppedDatabaseId、sourceDatabaseDeletionDate を指定しないでください。CreateMode は PointInTimeRestore、Restore、または Recover である必要があります。 createMode が PointInTimeRestore の場合、sourceResourceId は既存のデータベースまたは既存の SQL プールのリソース ID である必要があり、restorePointInTime を指定する必要があります。 createMode が Restore の場合、sourceResourceId は、復元可能な削除されたデータベースまたは復元可能な削除された SQL プールのリソース ID である必要があります。 createMode が Recover の場合、sourceResourceId は回復可能なデータベースまたは回復可能な SQL プールのリソース ID である必要があります。ソースサブスクリプションがターゲットサブスクリプションとは異なるテナントに属している場合、"x-ms-authorization-auxiliary" ヘッダーにはソーステナントの認証トークンが含まれている必要があります。 "x-ms-authorization-auxiliary" ヘッダーの詳細については、https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant を参照してください。
properties.status	DatabaseStatus	データベースの状態。
properties.zoneRedundant	boolean	このデータベースがゾーン冗長かどうか。つまり、このデータベースのレプリカは複数の可用性ゾーンに分散されます。
sku	Sku	データベース SKU。 SKU の一覧は、リージョンとサポートプランによって異なる場合があります。 Azure リージョンのサブスクリプションで使用できる SKU (SKU 名、レベル/エディション、ファミリ、容量を含む) を確認するには、`Capabilities_ListByLocation` REST API または次のいずれかのコマンドを使用します。 `az sql db list-editions -l <location> -o table` `Get-AzSqlServerServiceObjective -Location <location>`
tags	object	リソースタグ。
type	string	リソースの種類。

DatabaseIdentity

Object

リソースの Azure Active Directory ID 構成。

名前	型	説明
tenantId	string (uuid)	Azure Active Directory テナント ID。
type	DatabaseIdentityType	ID の種類
userAssignedIdentities	<string, DatabaseUserIdentity>	使用するユーザー割り当て ID のリソース ID

DatabaseIdentityType

列挙

ID の種類

値	説明
None
UserAssigned

DatabaseLicenseType

列挙

このデータベースに適用するライセンスの種類。ライセンスが必要な場合は LicenseIncluded、ライセンスを所有していて Azure ハイブリッド特典の対象となる場合は BasePrice します。

値	説明
BasePrice
LicenseIncluded

DatabaseListResult

Object

データベースの一覧。

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

DatabaseReadScale

列挙

読み取り専用ルーティングの状態。有効にした場合、アプリケーションの意図が接続文字列で読み取り専用に設定されている接続は、同じリージョンの読み取り専用セカンダリレプリカにルーティングされる可能性があります。エラスティックプール内の Hyperscale データベースには適用されません。

値	説明
Disabled
Enabled

DatabaseStatus

列挙

データベースの状態。

値	説明
AutoClosed
Copying
Creating
Disabled
EmergencyMode
Inaccessible
Offline
OfflineChangingDwPerformanceTiers
OfflineSecondary
Online
OnlineChangingDwPerformanceTiers
Paused
Pausing
Recovering
RecoveryPending
Restoring
Resuming
Scaling
Shutdown
Standby
Starting
Stopped
Stopping
Suspect

DatabaseUserIdentity

Object

リソースの Azure Active Directory ID 構成。

名前	型	説明
clientId	string (uuid)	Azure Active Directory クライアント ID。
principalId	string (uuid)	Azure Active Directory プリンシパル ID。

SampleName

列挙

このデータベースの作成時に適用するサンプルスキーマの名前。

値	説明
AdventureWorksLT
WideWorldImportersFull
WideWorldImportersStd

SecondaryType

列挙

データベースがセカンダリの場合は、そのセカンダリの種類。有効な値は Geo と Named です。

値	説明
Geo
Named

Sku

Object

ARM リソース SKU。

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

次の方法で共有

Databases - List By Elastic Pool

URI パラメーター

応答

例

Gets a list of databases in an elastic pool.

要求のサンプル

応答のサンプル

定義

BackupStorageRedundancy

CatalogCollationType

CreateMode

Database

DatabaseIdentity

DatabaseIdentityType

DatabaseLicenseType

DatabaseListResult

DatabaseReadScale

DatabaseStatus

DatabaseUserIdentity

SampleName

SecondaryType

Sku

その他のリソース