Databases - List By Server

取得資料庫的清單。

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

URI 參數

Name In Required Type Description
resourceGroupName
path True
  • string

包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。

serverName
path True
  • string

伺服器的名稱。

subscriptionId
path True
  • string

可識別 Azure 訂用帳戶的訂用帳戶識別碼。

api-version
query True
  • string

要用於要求的 API 版本。

回應

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=2019-06-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",
        "defaultSecondaryLocation": "North Europe",
        "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
        "licenseType": "LicenseIncluded",
        "maxLogSizeBytes": 104857600,
        "readScale": "Enabled",
        "readReplicaCount": 1
      },
      "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"
      },
      "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",
        "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/master",
      "name": "master",
      "type": "Microsoft.Sql/servers/databases"
    }
  ]
}

定義

CatalogCollationType

中繼資料目錄的定序。

CreateMode

指定建立資料庫的模式。

預設:建立一般資料庫。

Copy:將資料庫建立為現有資料庫的複本。 必須將 sourceDatabaseId 指定為源資料庫的資源識別碼。

次要:將資料庫建立為現有資料庫的次要複本。 必須將 sourceDatabaseId 指定為現有主資料庫的資源識別碼。

PointInTimeRestore:藉由還原現有資料庫的時間點備份來建立資料庫。 必須將 sourceDatabaseId 指定為現有資料庫的資源識別碼,而且必須指定 restorePointInTime。

復原:還原異地複寫備份來建立資料庫。 必須將 sourceDatabaseId 指定為要還原的可復原資料庫資源識別碼。

Restore:藉由還原已刪除資料庫的備份來建立資料庫。 必須指定 sourceDatabaseId。 如果 sourceDatabaseId 是資料庫的原始資源識別碼,則必須指定 sourceDatabaseDeletionDate。 否則 sourceDatabaseId 必須是可還原的已卸載資料庫資源識別碼,而 sourceDatabaseDeletionDate 則會被忽略。 您也可以指定 restorePointInTime 從較早的時間點還原。

RestoreLongTermRetentionBackup:從長期保留保存庫還原來建立資料庫。 必須將 recoveryServicesRecoveryPointResourceId 指定為復原點資源識別碼。

倉儲版本不支援複製、次要和 RestoreLongTermRetentionBackup。

Database

資料庫資源。

DatabaseLicenseType

要套用至此資料庫的授權類型。 LicenseIncluded 如果您需要授權,或 BasePrice 您擁有授權且符合 Azure Hybrid Benefit 資格。

DatabaseListResult

資料庫清單。

DatabaseReadScale

唯讀路由的狀態。 如果啟用,在其連接字串中將應用程式意圖設為 readonly 的連接,可能會路由至相同區域中的 readonly 次要複本。

DatabaseStatus

資料庫的狀態。

SampleName

建立此資料庫時要套用之範例架構的名稱。

Sku

ARM 資源 SKU。

StorageAccountType

用來儲存此資料庫備份的儲存體帳戶類型。

CatalogCollationType

中繼資料目錄的定序。

Name Type Description
DATABASE_DEFAULT
  • string
SQL_Latin1_General_CP1_CI_AS
  • string

CreateMode

指定建立資料庫的模式。

預設:建立一般資料庫。

Copy:將資料庫建立為現有資料庫的複本。 必須將 sourceDatabaseId 指定為源資料庫的資源識別碼。

次要:將資料庫建立為現有資料庫的次要複本。 必須將 sourceDatabaseId 指定為現有主資料庫的資源識別碼。

PointInTimeRestore:藉由還原現有資料庫的時間點備份來建立資料庫。 必須將 sourceDatabaseId 指定為現有資料庫的資源識別碼,而且必須指定 restorePointInTime。

復原:還原異地複寫備份來建立資料庫。 必須將 sourceDatabaseId 指定為要還原的可復原資料庫資源識別碼。

Restore:藉由還原已刪除資料庫的備份來建立資料庫。 必須指定 sourceDatabaseId。 如果 sourceDatabaseId 是資料庫的原始資源識別碼,則必須指定 sourceDatabaseDeletionDate。 否則 sourceDatabaseId 必須是可還原的已卸載資料庫資源識別碼,而 sourceDatabaseDeletionDate 則會被忽略。 您也可以指定 restorePointInTime 從較早的時間點還原。

RestoreLongTermRetentionBackup:從長期保留保存庫還原來建立資料庫。 必須將 recoveryServicesRecoveryPointResourceId 指定為復原點資源識別碼。

倉儲版本不支援複製、次要和 RestoreLongTermRetentionBackup。

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

Database

資料庫資源。

Name Type Description
id
  • string

資源識別碼。

kind
  • string

資料庫的種類。 這是用於 Azure 入口網站體驗的中繼資料。

location
  • string

資源位置。

managedBy
  • string

管理資料庫的資源。

name
  • string

資源名稱。

properties.autoPauseDelay
  • integer

自動暫停資料庫的時間(以分鐘為單位)。 -1 的值表示已停用自動暫停

properties.catalogCollation

中繼資料目錄的定序。

properties.collation
  • string

資料庫的定序。

properties.createMode

指定建立資料庫的模式。

預設:建立一般資料庫。

Copy:將資料庫建立為現有資料庫的複本。 必須將 sourceDatabaseId 指定為源資料庫的資源識別碼。

次要:將資料庫建立為現有資料庫的次要複本。 必須將 sourceDatabaseId 指定為現有主資料庫的資源識別碼。

PointInTimeRestore:藉由還原現有資料庫的時間點備份來建立資料庫。 必須將 sourceDatabaseId 指定為現有資料庫的資源識別碼,而且必須指定 restorePointInTime。

復原:還原異地複寫備份來建立資料庫。 必須將 sourceDatabaseId 指定為要還原的可復原資料庫資源識別碼。

Restore:藉由還原已刪除資料庫的備份來建立資料庫。 必須指定 sourceDatabaseId。 如果 sourceDatabaseId 是資料庫的原始資源識別碼,則必須指定 sourceDatabaseDeletionDate。 否則 sourceDatabaseId 必須是可還原的已卸載資料庫資源識別碼,而 sourceDatabaseDeletionDate 則會被忽略。 您也可以指定 restorePointInTime 從較早的時間點還原。

RestoreLongTermRetentionBackup:從長期保留保存庫還原來建立資料庫。 必須將 recoveryServicesRecoveryPointResourceId 指定為復原點資源識別碼。

倉儲版本不支援複製、次要和 RestoreLongTermRetentionBackup。

properties.creationDate
  • string

資料庫的建立日期 (ISO8601 格式) 。

properties.currentServiceObjectiveName
  • string

資料庫目前的服務等級目標名稱。

properties.currentSku

SKU 的名稱和層級。

properties.databaseId
  • string

資料庫的識別碼。

properties.defaultSecondaryLocation
  • string

此資料庫的預設次要區域。

properties.earliestRestoreDate
  • string

這會記錄此資料庫可用的最早開始日期和時間 (ISO8601 格式) 。

properties.elasticPoolId
  • string

包含此資料庫之彈性集區的資源識別碼。

properties.failoverGroupId
  • string

此資料庫所屬的容錯移轉群組資源識別碼。

properties.licenseType

要套用至此資料庫的授權類型。 LicenseIncluded 如果您需要授權,或 BasePrice 您擁有授權且符合 Azure Hybrid Benefit 資格。

properties.longTermRetentionBackupResourceId
  • string

與此資料庫建立作業相關聯之長期保留備份的資源識別碼。

properties.maxLogSizeBytes
  • integer

此資料庫的記錄檔大小上限。

properties.maxSizeBytes
  • integer

以位元組為單位的資料庫大小上限。

properties.minCapacity
  • number

資料庫一律會配置的最基本容量(如果未暫停)

properties.pausedDate
  • string

使用者設定或動作暫停資料庫的日期 (ISO8601 格式) 。 如果資料庫已就緒,則為 Null。

properties.readReplicaCount
  • integer

與資料庫相關聯的唯讀次要複本數目。

properties.readScale

唯讀路由的狀態。 如果啟用,在其連接字串中將應用程式意圖設為 readonly 的連接,可能會路由至相同區域中的 readonly 次要複本。

properties.recoverableDatabaseId
  • string

與此資料庫建立作業相關聯之可復原資料庫的資源識別碼。

properties.recoveryServicesRecoveryPointId
  • string

與此資料庫建立作業相關聯之復原點的資源識別碼。

properties.requestedServiceObjectiveName
  • string

要求的資料庫服務等級目標名稱。

properties.restorableDroppedDatabaseId
  • string

與此資料庫建立作業相關聯之可還原之已卸載資料庫的資源識別碼。

properties.restorePointInTime
  • string

指定將會還原來建立新資料庫之源資料庫的 (ISO8601 格式) 的時間點。

properties.resumedDate
  • string

使用者動作或資料庫登入繼續資料庫的日期 (ISO8601 格式) 。 如果資料庫已暫停,則為 Null。

properties.sampleName

建立此資料庫時要套用之範例架構的名稱。

properties.sourceDatabaseDeletionDate
  • string

指定刪除資料庫的時間。

properties.sourceDatabaseId
  • string

與此資料庫建立作業相關聯之源資料庫的資源識別碼。

properties.status

資料庫的狀態。

properties.storageAccountType

用來儲存此資料庫備份的儲存體帳戶類型。

properties.zoneRedundant
  • boolean

此資料庫是否為區域多餘的,這表示此資料庫的複本會分散到多個可用性區域。

sku

資料庫 SKU。

Sku 清單可能依區域和支援供應專案而有所不同。 若要判斷 Sku (包括在 Azure 區域中可供您的訂用帳戶使用的 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 Hybrid Benefit 資格。

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

DatabaseListResult

資料庫清單。

Name Type Description
nextLink
  • string

用來取出下一頁結果的連結。

value

結果的陣列。

DatabaseReadScale

唯讀路由的狀態。 如果啟用,在其連接字串中將應用程式意圖設為 readonly 的連接,可能會路由至相同區域中的 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

SampleName

建立此資料庫時要套用之範例架構的名稱。

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

Sku

ARM 資源 SKU。

Name Type Description
capacity
  • integer

特定 SKU 的容量。

family
  • string

如果服務具有不同的硬體世代,則針對相同的 SKU,您可以在這裡加以捕獲。

name
  • string

SKU 的名稱,通常是字母 + 數位代碼,例如 P3。

size
  • string

特定 SKU 的大小

tier
  • string

特定 SKU 的層級或版本,例如 Basic、Premium。

StorageAccountType

用來儲存此資料庫備份的儲存體帳戶類型。

Name Type Description
GRS
  • string
LRS
  • string
ZRS
  • string