Databases - List By Elastic Pool

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

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

URI パラメーター

Name In Required Type Description
elasticPoolName
path True
  • string

エラスティックプールの名前。

resourceGroupName
path True
  • string

リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

serverName
path True
  • string

サーバーの名前。

subscriptionId
path True
  • string

Azure サブスクリプションを識別するサブスクリプション ID。

api-version
query True
  • string

要求で使用する API のバージョン。

応答

Name Type Description
200 OK

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

Other Status Codes

エラー応答: * * *

  • 404 Subscription・ Nothaveserver-要求されたサーバーが見つかりませんでした

  • 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.

Sample Request

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-02-01-preview

Sample Response

{
  "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"
    }
  ]
}

定義

CatalogCollationType

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

CreateMode

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

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

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

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

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

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

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

RestoreLongTermRetentionBackup: 長期保存コンテナーからの復元によってデータベースを作成します。 Recoveryサービス Recoverypointresourceid は、復旧ポイントのリソース ID として指定する必要があります。

Copy、Secondary、および RestoreLongTermRetentionBackup は、DataWarehouse エディションではサポートされていません。

CurrentBackupStorageRedundancy

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

Database

データベースリソース。

DatabaseLicenseType

このデータベースに適用するライセンスの種類。 LicenseIncluded ライセンスが必要な場合、または BasePrice ライセンスがあり、Azure ハイブリッド特典の資格がある場合。

DatabaseListResult

データベースの一覧です。

DatabaseReadScale

読み取り専用ルーティングの状態。 有効にした場合、接続文字列でアプリケーションインテントが readonly に設定されている接続は、同じリージョン内の読み取り専用セカンダリレプリカにルーティングされる可能性があります。

DatabaseStatus

データベースの状態。

RequestedBackupStorageRedundancy

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

SampleName

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

SecondaryType

セカンダリデータベースの場合は、セカンダリの種類。 有効な値は Geo および名前付きです。

Sku

ARM リソース SKU。

CatalogCollationType

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

Name Type Description
DATABASE_DEFAULT
  • string
SQL_Latin1_General_CP1_CI_AS
  • string

CreateMode

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

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

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

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

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

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

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

RestoreLongTermRetentionBackup: 長期保存コンテナーからの復元によってデータベースを作成します。 Recoveryサービス Recoverypointresourceid は、復旧ポイントのリソース ID として指定する必要があります。

Copy、Secondary、および RestoreLongTermRetentionBackup は、DataWarehouse エディションではサポートされていません。

Name Type Description
Copy
  • string
Default
  • string
OnlineSecondary
  • string
PointInTimeRestore
  • string
Recovery
  • string
Restore
  • string
RestoreExternalBackup
  • string
RestoreExternalBackupSecondary
  • string
RestoreLongTermRetentionBackup
  • string
Secondary
  • string

CurrentBackupStorageRedundancy

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

Name Type Description
Geo
  • string
Local
  • string
Zone
  • string

Database

データベースリソース。

Name Type Description
id
  • string

リソースの ID

kind
  • string

データベースの種類。 これは Azure portal エクスペリエンスに使用されるメタデータです。

location
  • string

リソースの場所。

managedBy
  • string

データベースを管理するリソース。

name
  • string

リソース名。

properties.autoPauseDelay
  • integer

データベースが自動的に一時停止されるまでの時間 (分単位)。 値-1 は、自動一時停止が無効になっていることを意味します。

properties.catalogCollation

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

properties.collation
  • string

データベースの照合順序。

properties.createMode

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

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

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

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

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

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

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

RestoreLongTermRetentionBackup: 長期保存コンテナーからの復元によってデータベースを作成します。 Recoveryサービス Recoverypointresourceid は、復旧ポイントのリソース ID として指定する必要があります。

Copy、Secondary、および RestoreLongTermRetentionBackup は、DataWarehouse エディションではサポートされていません。

properties.creationDate
  • string

データベースの作成日 (データ形式)。

properties.currentBackupStorageRedundancy

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

properties.currentServiceObjectiveName
  • string

データベースの現在のサービスレベル目標名。

properties.currentSku

SKU の名前と層。

properties.databaseId
  • string

データベースの ID です。

properties.defaultSecondaryLocation
  • string

このデータベースの既定のセカンダリリージョン。

properties.earliestRestoreDate
  • string

これにより、このデータベースで復元が使用可能な最も古い開始日時が記録されます (//形式)。

properties.elasticPoolId
  • string

このデータベースを含むエラスティックプールのリソース識別子。

properties.failoverGroupId
  • string

このデータベースが属するフェールオーバーグループリソース識別子。

properties.highAvailabilityReplicaCount
  • integer

高可用性を実現するために使用される、データベースに関連付けられているセカンダリレプリカの数。

properties.isInfraEncryptionEnabled
  • boolean

このデータベースでは、インフラストラクチャ暗号化が有効になっています。

properties.isLedgerOn
  • boolean

このデータベースが台帳データベースであるかどうか。これは、データベース内のすべてのテーブルが台帳テーブルであることを意味します。 注: このプロパティの値は、データベースの作成後に変更することはできません。

properties.licenseType

このデータベースに適用するライセンスの種類。 LicenseIncluded ライセンスが必要な場合、または BasePrice ライセンスがあり、Azure ハイブリッド特典の資格がある場合。

properties.longTermRetentionBackupResourceId
  • string

このデータベースの作成操作に関連付けられた長期的な保有期間のバックアップのリソース識別子。

properties.maintenanceConfigurationId
  • string

データベースに割り当てられたメンテナンス構成 id。 この構成は、メンテナンスの更新を実行する期間を定義します。

properties.maxLogSizeBytes
  • integer

このデータベースの最大ログサイズ。

properties.maxSizeBytes
  • integer

データベースの最大サイズをバイト単位で表します。

properties.minCapacity
  • number

データベースが常に割り当てられている最小容量 (一時停止していない場合)

properties.pausedDate
  • string

データベースがユーザーの構成または操作によって一時停止された日付 (//形式)。 データベースの準備ができている場合は Null です。

properties.readScale

読み取り専用ルーティングの状態。 有効にした場合、接続文字列でアプリケーションインテントが readonly に設定されている接続は、同じリージョン内の読み取り専用セカンダリレプリカにルーティングされる可能性があります。

properties.recoverableDatabaseId
  • string

このデータベースの作成操作に関連付けられている回復可能なデータベースのリソース識別子。

properties.recoveryServicesRecoveryPointId
  • string

このデータベースの作成操作に関連付けられている回復ポイントのリソース識別子。

properties.requestedBackupStorageRedundancy

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

properties.requestedServiceObjectiveName
  • string

要求されたデータベースのサービスレベル目標名。

properties.restorableDroppedDatabaseId
  • string

このデータベースの作成操作に関連付けられている、復元可能な削除されたデータベースのリソース識別子。

properties.restorePointInTime
  • string

新しいデータベースを作成するために復元されるソースデータベースの特定の時点 (データ形式) を指定します。

properties.resumedDate
  • string

ユーザー操作またはデータベースログインによってデータベースが再開された日付 (///形式)。 データベースが一時停止されている場合は Null です。

properties.sampleName

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

properties.secondaryType

セカンダリデータベースの場合は、セカンダリの種類。 有効な値は Geo および名前付きです。

properties.sourceDatabaseDeletionDate
  • string

データベースが削除された時刻を指定します。

properties.sourceDatabaseId
  • string

このデータベースの作成操作に関連付けられているソースデータベースのリソース識別子です。

properties.status

データベースの状態。

properties.zoneRedundant
  • boolean

このデータベースがゾーン冗長であるかどうか。これは、このデータベースのレプリカが複数の可用性ゾーンに分散されることを意味します。

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

リソースの種類。

DatabaseLicenseType

このデータベースに適用するライセンスの種類。 LicenseIncluded ライセンスが必要な場合、または BasePrice ライセンスがあり、Azure ハイブリッド特典の資格がある場合。

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

DatabaseListResult

データベースの一覧です。

Name Type Description
nextLink
  • string

結果の次のページを取得するためのリンク。

value

結果の配列。

DatabaseReadScale

読み取り専用ルーティングの状態。 有効にした場合、接続文字列でアプリケーションインテントが readonly に設定されている接続は、同じリージョン内の読み取り専用セカンダリレプリカにルーティングされる可能性があります。

Name Type Description
Disabled
  • string
Enabled
  • string

DatabaseStatus

データベースの状態。

Name Type Description
AutoClosed
  • string
Copying
  • string
Creating
  • string
Disabled
  • string
EmergencyMode
  • string
Inaccessible
  • string
Offline
  • string
OfflineChangingDwPerformanceTiers
  • string
OfflineSecondary
  • string
Online
  • string
OnlineChangingDwPerformanceTiers
  • string
Paused
  • string
Pausing
  • string
Recovering
  • string
RecoveryPending
  • string
Restoring
  • string
Resuming
  • string
Scaling
  • string
Shutdown
  • string
Standby
  • string
Suspect
  • string

RequestedBackupStorageRedundancy

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

Name Type Description
Geo
  • string
Local
  • string
Zone
  • string

SampleName

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

Name Type Description
AdventureWorksLT
  • string
WideWorldImportersFull
  • string
WideWorldImportersStd
  • string

SecondaryType

セカンダリデータベースの場合は、セカンダリの種類。 有効な値は Geo および名前付きです。

Name Type Description
Geo
  • string
Named
  • string

Sku

ARM リソース SKU。

Name Type Description
capacity
  • integer

特定の SKU の容量。

family
  • string

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

name
  • string

SKU の名前。通常は、文字と数字のコード (P3 など) を指定します。

size
  • string

特定の SKU のサイズ

tier
  • string

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