Databases - List By Server

データベースの一覧を取得します。

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

URI パラメーター

Name In Required Type Description
resourceGroupName
path True
  • string

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

serverName
path True
  • string

サーバーの名前。

subscriptionId
path True
  • string

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

api-version
query True
  • string

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

$skipToken
query
  • string

応答

Name Type Description
200 OK

データベースの一覧が正常に取得されました。

Other Status Codes

エラー応答: ***

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

  • 404 ServerNotInSubscriptionResourceGroup - 指定されたリソース グループとサブスクリプションに指定されたサーバーが存在しません。

Gets a list of databases.

Sample Request

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

Sample Response

{
  "value": [
    {
      "sku": {
        "name": "BC_Gen4",
        "tier": "BusinessCritical",
        "capacity": 2
      },
      "kind": "v12.0,user,vcore",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 268435456000,
        "status": "Online",
        "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
        "creationDate": "2017-06-07T04:41:33.937Z",
        "currentServiceObjectiveName": "BC_Gen4_2",
        "requestedServiceObjectiveName": "BC_Gen4_2",
        "defaultSecondaryLocation": "North Europe",
        "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
        "licenseType": "LicenseIncluded",
        "maxLogSizeBytes": 104857600,
        "isInfraEncryptionEnabled": false,
        "zoneRedundant": false,
        "readScale": "Enabled",
        "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
        "currentSku": {
          "name": "BC_Gen4",
          "tier": "BusinessCritical",
          "capacity": 2
        },
        "currentBackupStorageRedundancy": "Zone",
        "requestedBackupStorageRedundancy": "Zone",
        "isLedgerOn": false
      },
      "location": "southeastasia",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
      "name": "testdb",
      "type": "Microsoft.Sql/servers/databases"
    },
    {
      "sku": {
        "name": "System0",
        "tier": "System",
        "capacity": 0
      },
      "kind": "v12.0,system",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 32212254720,
        "status": "Online",
        "databaseId": "e6be351f-2cc9-4604-9e52-b0b28b2710b0",
        "creationDate": "2017-06-07T04:23:42.537Z",
        "currentServiceObjectiveName": "System0",
        "requestedServiceObjectiveName": "System0",
        "defaultSecondaryLocation": "North Europe",
        "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
        "isInfraEncryptionEnabled": false,
        "zoneRedundant": false,
        "readScale": "Disabled",
        "currentSku": {
          "name": "System0",
          "tier": "System",
          "capacity": 0
        },
        "currentBackupStorageRedundancy": "Local",
        "requestedBackupStorageRedundancy": "Local",
        "isLedgerOn": false
      },
      "location": "southeastasia",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/master",
      "name": "master",
      "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: 長期保持コンテナーから復元してデータベースを作成します。 recoveryServicesRecoveryPointResourceId は、復旧ポイントのリソース ID として指定する必要があります。

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

CurrentBackupStorageRedundancy

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

Database

データベース リソース。

DatabaseLicenseType

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

DatabaseListResult

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

DatabaseReadScale

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

DatabaseStatus

データベースの状態。

RequestedBackupStorageRedundancy

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

SampleName

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

SecondaryType

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

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

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

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

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

properties.creationDate
  • string

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

properties.currentBackupStorageRedundancy

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

properties.currentServiceObjectiveName
  • string

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

properties.currentSku

SKU の名前とレベル。

properties.databaseId
  • string

データベースの ID です。

properties.defaultSecondaryLocation
  • string

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

properties.earliestRestoreDate
  • string

これにより、このデータベースで復元できる最も早い開始日と時刻が記録されます (ISO8601 形式)。

properties.elasticPoolId
  • string

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

properties.failoverGroupId
  • string

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

properties.highAvailabilityReplicaCount
  • integer

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

properties.isInfraEncryptionEnabled
  • boolean

このデータベースでは、Infra 暗号化が有効になっています。

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

ユーザー構成またはアクション (ISO8601 形式) によってデータベースが一時停止された日付。 データベースの準備ができた場合は Null。

properties.readScale

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

properties.recoverableDatabaseId
  • string

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

properties.recoveryServicesRecoveryPointId
  • string

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

properties.requestedBackupStorageRedundancy

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

properties.requestedServiceObjectiveName
  • string

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

properties.restorableDroppedDatabaseId
  • string

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

properties.restorePointInTime
  • string

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

properties.resumedDate
  • string

ユーザー アクションまたはデータベース ログイン (ISO8601 形式) によってデータベースが再開された日付。 データベースが一時停止されている場合は Null。

properties.sampleName

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

properties.secondaryType

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

properties.sourceDatabaseDeletionDate
  • string

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

properties.sourceDatabaseId
  • string

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

properties.status

データベースの状態。

properties.zoneRedundant
  • boolean

このデータベースがゾーン冗長かどうか。つまり、このデータベースのレプリカは複数の可用性ゾーンに分散されます。

sku

データベース SKU。

SKU の一覧は、リージョンとサポート オファーによって異なる場合があります。 Azure リージョンのサブスクリプションで使用できる SKU (SKU 名、レベル/エディション、ファミリ、容量を含む) を確認するには、REST API または次のいずれかのコマンドを使用 Capabilities_ListByLocation します。

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

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

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 と Named です。

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、プレミアムなど)。