Databases - List By Elastic Pool

Referensi

Layanan:: SQL Database

Versi API:: 2021-11-01

Mendapatkan daftar database dalam kumpulan elastis.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
elasticPoolName	path	True	string	Nama kumpulan elastis.
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi sumber daya. Anda dapat memperoleh nilai ini dari Azure Resource Manager API atau portal.
serverName	path	True	string	Nama server.
subscriptionId	path	True	string	ID langganan yang mengidentifikasi langganan Azure.
api-version	query	True	string	Versi API yang digunakan untuk permintaan.

Respons

Nama	Jenis	Deskripsi
200 OK	DatabaseListResult	Berhasil mengambil daftar database dalam kumpulan elastis.
Other Status Codes		Respons Kesalahan: *** 404 SubscriptionDoesNotHaveServer - Server yang diminta tidak ditemukan 404 ServerNotInSubscriptionResourceGroup - Server yang ditentukan tidak ada di grup sumber daya dan langganan yang ditentukan. 404 CannotFindObject - Tidak dapat menemukan objek karena tidak ada atau Anda tidak memiliki izin 404 ServerNotInSubscriptionResourceGroup - Server yang ditentukan tidak ada di grup sumber daya dan langganan yang ditentukan. 404 ServerNotInSubscription - Server yang ditentukan tidak ada pada langganan yang ditentukan. 429 SubscriptionTooManyCreateUpdateRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia. 429 SubscriptionTooManyRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia. 503 TooManyRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia. 504 RequestTimeout - Permintaan layanan melebihi batas waktu yang diizinkan.

Nama

Jenis

Deskripsi

200 OK

DatabaseListResult

Berhasil mengambil daftar database dalam kumpulan elastis.

Other Status Codes

Respons Kesalahan: ***

404 SubscriptionDoesNotHaveServer - Server yang diminta tidak ditemukan
404 ServerNotInSubscriptionResourceGroup - Server yang ditentukan tidak ada di grup sumber daya dan langganan yang ditentukan.
404 CannotFindObject - Tidak dapat menemukan objek karena tidak ada atau Anda tidak memiliki izin
404 ServerNotInSubscriptionResourceGroup - Server yang ditentukan tidak ada di grup sumber daya dan langganan yang ditentukan.
404 ServerNotInSubscription - Server yang ditentukan tidak ada pada langganan yang ditentukan.
429 SubscriptionTooManyCreateUpdateRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia.
429 SubscriptionTooManyRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia.
503 TooManyRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia.
504 RequestTimeout - Permintaan layanan melebihi batas waktu yang diizinkan.

Contoh

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

Respon sampel

Kode status:: 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"
    }
  ]
}

Definisi

Nama	Deskripsi
BackupStorageRedundancy	Jenis akun penyimpanan yang digunakan untuk menyimpan cadangan untuk database ini.
CatalogCollationType	Kolate katalog metadata.
CreateMode	Menentukan mode pembuatan database. Default: pembuatan database reguler. Salin: membuat database sebagai salinan database yang sudah ada. sourceDatabaseId harus ditentukan sebagai ID sumber daya database sumber. Sekunder: membuat database sebagai replika sekunder dari database yang ada. sourceDatabaseId harus ditentukan sebagai ID sumber daya dari database utama yang ada. PointInTimeRestore: Membuat database dengan memulihkan cadangan titik waktu database yang sudah ada. sourceDatabaseId harus ditentukan sebagai ID sumber daya database yang ada, dan restorePointInTime harus ditentukan. Pemulihan: Membuat database dengan memulihkan cadangan yang direplikasi secara geografis. sourceDatabaseId harus ditentukan sebagai ID sumber daya database yang dapat dipulihkan untuk dipulihkan. Pemulihan: Membuat database dengan memulihkan cadangan database yang dihapus. sourceDatabaseId harus ditentukan. Jika sourceDatabaseId adalah ID sumber daya asli database, maka sourceDatabaseDeletionDate harus ditentukan. Jika tidak, sourceDatabaseId harus berupa ID sumber daya database yang dihilangkan dan sourceDatabaseDeletionDate diabaikan. restorePointInTime juga dapat ditentukan untuk memulihkan dari titik waktu sebelumnya. RestoreLongTermRetentionBackup: Membuat database dengan memulihkan dari vault retensi jangka panjang. recoveryServicesRecoveryPointResourceId harus ditentukan sebagai ID sumber daya titik pemulihan. Copy, Secondary, dan RestoreLongTermRetentionBackup tidak didukung untuk edisi DataWarehouse.
Database	Sumber daya database.
DatabaseIdentity	Konfigurasi identitas Azure Active Directory untuk sumber daya.
DatabaseIdentityType	Jenis identitas
DatabaseLicenseType	Jenis lisensi yang akan diterapkan untuk database ini. `LicenseIncluded` jika Anda memerlukan lisensi, atau `BasePrice` jika Anda memiliki lisensi dan memenuhi syarat untuk Azure Hybrid Benefit.
DatabaseListResult	Daftar database.
DatabaseReadScale	Status perutean baca-saja. Jika diaktifkan, koneksi yang memiliki niat aplikasi diatur ke baca-saja di string koneksi mereka dapat dirutekan ke replika sekunder baca-saja di wilayah yang sama. Tidak berlaku untuk database Hyperscale dalam kumpulan elastis.
DatabaseStatus	Status database.
DatabaseUserIdentity	Konfigurasi identitas Azure Active Directory untuk sumber daya.
SampleName	Nama skema sampel yang akan diterapkan saat membuat database ini.
SecondaryType	Jenis sekunder database jika merupakan sekunder. Nilai yang valid adalah Geo dan Named.
Sku	SKU Sumber Daya ARM.

BackupStorageRedundancy

Jenis akun penyimpanan yang digunakan untuk menyimpan cadangan untuk database ini.

Nama	Jenis	Deskripsi
Geo	string
GeoZone	string
Local	string
Zone	string

CatalogCollationType

Kolate katalog metadata.

Nama	Jenis	Deskripsi
DATABASE_DEFAULT	string
SQL_Latin1_General_CP1_CI_AS	string

CreateMode

Menentukan mode pembuatan database.

Default: pembuatan database reguler.

Salin: membuat database sebagai salinan database yang sudah ada. sourceDatabaseId harus ditentukan sebagai ID sumber daya database sumber.

Sekunder: membuat database sebagai replika sekunder dari database yang ada. sourceDatabaseId harus ditentukan sebagai ID sumber daya dari database utama yang ada.

PointInTimeRestore: Membuat database dengan memulihkan cadangan titik waktu database yang sudah ada. sourceDatabaseId harus ditentukan sebagai ID sumber daya database yang ada, dan restorePointInTime harus ditentukan.

Pemulihan: Membuat database dengan memulihkan cadangan yang direplikasi secara geografis. sourceDatabaseId harus ditentukan sebagai ID sumber daya database yang dapat dipulihkan untuk dipulihkan.

Pemulihan: Membuat database dengan memulihkan cadangan database yang dihapus. sourceDatabaseId harus ditentukan. Jika sourceDatabaseId adalah ID sumber daya asli database, maka sourceDatabaseDeletionDate harus ditentukan. Jika tidak, sourceDatabaseId harus berupa ID sumber daya database yang dihilangkan dan sourceDatabaseDeletionDate diabaikan. restorePointInTime juga dapat ditentukan untuk memulihkan dari titik waktu sebelumnya.

RestoreLongTermRetentionBackup: Membuat database dengan memulihkan dari vault retensi jangka panjang. recoveryServicesRecoveryPointResourceId harus ditentukan sebagai ID sumber daya titik pemulihan.

Copy, Secondary, dan RestoreLongTermRetentionBackup tidak didukung untuk edisi DataWarehouse.

Nama	Jenis	Deskripsi
Copy	string
Default	string
OnlineSecondary	string
PointInTimeRestore	string
Recovery	string
Restore	string
RestoreExternalBackup	string
RestoreExternalBackupSecondary	string
RestoreLongTermRetentionBackup	string
Secondary	string

Database

Sumber daya database.

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.
identity	DatabaseIdentity	Identitas Azure Active Directory database.
kind	string	Jenis database. Ini adalah metadata yang digunakan untuk pengalaman portal Azure.
location	string	Lokasi sumber daya.
managedBy	string	Sumber daya yang mengelola database.
name	string	Nama sumber daya.
properties.autoPauseDelay	integer	Waktu dalam menit setelah database dijeda secara otomatis. Nilai -1 berarti jeda otomatis dinonaktifkan
properties.catalogCollation	CatalogCollationType	Kolate katalog metadata.
properties.collation	string	Kolatasi database.
properties.createMode	CreateMode	Menentukan mode pembuatan database. Default: pembuatan database reguler. Salin: membuat database sebagai salinan database yang sudah ada. sourceDatabaseId harus ditentukan sebagai ID sumber daya database sumber. Sekunder: membuat database sebagai replika sekunder dari database yang ada. sourceDatabaseId harus ditentukan sebagai ID sumber daya dari database utama yang ada. PointInTimeRestore: Membuat database dengan memulihkan cadangan titik waktu database yang sudah ada. sourceDatabaseId harus ditentukan sebagai ID sumber daya database yang ada, dan restorePointInTime harus ditentukan. Pemulihan: Membuat database dengan memulihkan cadangan yang direplikasi secara geografis. sourceDatabaseId harus ditentukan sebagai ID sumber daya database yang dapat dipulihkan untuk dipulihkan. Pemulihan: Membuat database dengan memulihkan cadangan database yang dihapus. sourceDatabaseId harus ditentukan. Jika sourceDatabaseId adalah ID sumber daya asli database, maka sourceDatabaseDeletionDate harus ditentukan. Jika tidak, sourceDatabaseId harus berupa ID sumber daya database yang dihilangkan dan sourceDatabaseDeletionDate diabaikan. restorePointInTime juga dapat ditentukan untuk memulihkan dari titik waktu sebelumnya. RestoreLongTermRetentionBackup: Membuat database dengan memulihkan dari vault retensi jangka panjang. recoveryServicesRecoveryPointResourceId harus ditentukan sebagai ID sumber daya titik pemulihan. Copy, Secondary, dan RestoreLongTermRetentionBackup tidak didukung untuk edisi DataWarehouse.
properties.creationDate	string	Tanggal pembuatan database (format ISO8601).
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Jenis akun penyimpanan yang digunakan untuk menyimpan cadangan untuk database ini.
properties.currentServiceObjectiveName	string	Nama tujuan tingkat layanan database saat ini.
properties.currentSku	Sku	Nama dan tingkat SKU.
properties.databaseId	string	ID database.
properties.defaultSecondaryLocation	string	Wilayah sekunder default untuk database ini.
properties.earliestRestoreDate	string	Ini mencatat tanggal dan waktu mulai paling awal yang pemulihan tersedia untuk database ini (format ISO8601).
properties.elasticPoolId	string	Pengidentifikasi sumber daya kumpulan elastis yang berisi database ini.
properties.failoverGroupId	string	Pengidentifikasi sumber daya Grup Failover tempat database ini berada.
properties.federatedClientId	string	Id Klien yang digunakan untuk skenario CMK lintas penyewa per database
properties.highAvailabilityReplicaCount	integer	Jumlah replika sekunder yang terkait dengan database yang digunakan untuk memberikan ketersediaan tinggi. Tidak berlaku untuk database Hyperscale dalam kumpulan elastis.
properties.isInfraEncryptionEnabled	boolean	Enkripsi Infra diaktifkan untuk database ini.
properties.isLedgerOn	boolean	Apakah database ini adalah database ledger atau tidak, yang berarti semua tabel dalam database adalah tabel ledger. Catatan: nilai properti ini tidak dapat diubah setelah database dibuat.
properties.licenseType	DatabaseLicenseType	Jenis lisensi yang akan diterapkan untuk database ini. `LicenseIncluded` jika Anda memerlukan lisensi, atau `BasePrice` jika Anda memiliki lisensi dan memenuhi syarat untuk Azure Hybrid Benefit.
properties.longTermRetentionBackupResourceId	string	Pengidentifikasi sumber daya cadangan retensi jangka panjang yang terkait dengan operasi pembuatan database ini.
properties.maintenanceConfigurationId	string	Id konfigurasi pemeliharaan yang ditetapkan ke database. Konfigurasi ini menentukan periode kapan pembaruan pemeliharaan akan terjadi.
properties.maxLogSizeBytes	integer	Ukuran log maks untuk database ini.
properties.maxSizeBytes	integer	Ukuran maksimum database yang dinyatakan dalam byte.
properties.minCapacity	number	Kapasitas minimal yang akan selalu dialokasikan database, jika tidak dijeda
properties.pausedDate	string	Tanggal saat database dijeda oleh konfigurasi atau tindakan pengguna (format ISO8601). Null jika database sudah siap.
properties.readScale	DatabaseReadScale	Status perutean baca-saja. Jika diaktifkan, koneksi yang memiliki niat aplikasi diatur ke baca-saja di string koneksi mereka dapat dirutekan ke replika sekunder baca-saja di wilayah yang sama. Tidak berlaku untuk database Hyperscale dalam kumpulan elastis.
properties.recoverableDatabaseId	string	Pengidentifikasi sumber daya database yang dapat dipulihkan yang terkait dengan operasi pembuatan database ini.
properties.recoveryServicesRecoveryPointId	string	Pengidentifikasi sumber daya titik pemulihan yang terkait dengan operasi pembuatan database ini.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Jenis akun penyimpanan yang akan digunakan untuk menyimpan cadangan untuk database ini.
properties.requestedServiceObjectiveName	string	Nama tujuan tingkat layanan database yang diminta.
properties.restorableDroppedDatabaseId	string	Pengidentifikasi sumber daya database yang dapat dihilangkan yang dapat dihilangkan yang terkait dengan operasi pembuatan database ini.
properties.restorePointInTime	string	Menentukan titik waktu (format ISO8601) database sumber yang akan dipulihkan untuk membuat database baru.
properties.resumedDate	string	Tanggal ketika database dilanjutkan oleh tindakan pengguna atau login database (format ISO8601). Null jika database dijeda.
properties.sampleName	SampleName	Nama skema sampel yang akan diterapkan saat membuat database ini.
properties.secondaryType	SecondaryType	Jenis sekunder database jika merupakan sekunder. Nilai yang valid adalah Geo dan Named.
properties.sourceDatabaseDeletionDate	string	Menentukan waktu database dihapus.
properties.sourceDatabaseId	string	Pengidentifikasi sumber daya database sumber yang terkait dengan operasi pembuatan database ini.
properties.sourceResourceId	string	Pengidentifikasi sumber daya sumber yang terkait dengan operasi pembuatan database ini. Properti ini hanya didukung untuk edisi DataWarehouse dan memungkinkan pemulihan di seluruh langganan. Ketika sourceResourceId ditentukan, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId dan sourceDatabaseDeletionDate tidak boleh ditentukan dan CreateMode harus PointInTimeRestore, Restore atau Recover. Ketika createMode adalah PointInTimeRestore, sourceResourceId harus menjadi ID sumber daya dari database yang ada atau kumpulan sql yang ada, dan restorePointInTime harus ditentukan. Ketika createMode adalah Restore, sourceResourceId harus menjadi ID sumber daya database yang dihilangkan yang dapat dipulihkan atau kumpulan sql yang dapat dihilangkan kembali. Ketika createMode adalah Recover, sourceResourceId harus menjadi ID sumber daya database yang dapat dipulihkan atau kumpulan sql yang dapat dipulihkan. Saat langganan sumber milik penyewa yang berbeda dari langganan target, header "x-ms-authorization-auxiliary" harus berisi token autentikasi untuk penyewa sumber. Untuk detail selengkapnya tentang header "x-ms-authorization-auxiliary" lihat https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
properties.status	DatabaseStatus	Status database.
properties.zoneRedundant	boolean	Apakah database ini zona redundan atau tidak, yang berarti replika database ini akan tersebar di beberapa zona ketersediaan.
sku	Sku	SKU database. Daftar SKU dapat bervariasi menurut wilayah dan penawaran dukungan. Untuk menentukan SKU (termasuk nama SKU, tingkat/edisi, keluarga, dan kapasitas) yang tersedia untuk langganan Anda di wilayah Azure, gunakan `Capabilities_ListByLocation` REST API atau salah satu perintah berikut: `az sql db list-editions -l <location> -o table` `Get-AzSqlServerServiceObjective -Location <location>`
tags	object	Tag sumber daya.
type	string	Jenis sumber daya

DatabaseIdentity

Konfigurasi identitas Azure Active Directory untuk sumber daya.

Nama	Jenis	Deskripsi
tenantId	string	Id penyewa Azure Active Directory.
type	DatabaseIdentityType	Jenis identitas
userAssignedIdentities	<string, DatabaseUserIdentity>	Id sumber daya dari identitas yang ditetapkan pengguna untuk digunakan

DatabaseIdentityType

Jenis identitas

Nama	Jenis	Deskripsi
None	string
UserAssigned	string

DatabaseLicenseType

Jenis lisensi yang akan diterapkan untuk database ini. LicenseIncluded jika Anda memerlukan lisensi, atau BasePrice jika Anda memiliki lisensi dan memenuhi syarat untuk Azure Hybrid Benefit.

Nama	Jenis	Deskripsi
BasePrice	string
LicenseIncluded	string

DatabaseListResult

Daftar database.

Nama	Jenis	Deskripsi
nextLink	string	Tautan untuk mengambil halaman hasil berikutnya.
value	Database[]	Array hasil.

DatabaseReadScale

Status perutean baca-saja. Jika diaktifkan, koneksi yang memiliki niat aplikasi diatur ke baca-saja di string koneksi mereka dapat dirutekan ke replika sekunder baca-saja di wilayah yang sama. Tidak berlaku untuk database Hyperscale dalam kumpulan elastis.

Nama	Jenis	Deskripsi
Disabled	string
Enabled	string

DatabaseStatus

Status database.

Nama	Jenis	Deskripsi
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
Starting	string
Stopped	string
Stopping	string
Suspect	string

DatabaseUserIdentity

Konfigurasi identitas Azure Active Directory untuk sumber daya.

Nama	Jenis	Deskripsi
clientId	string	Id klien Azure Active Directory.
principalId	string	Id utama Azure Active Directory.

SampleName

Nama skema sampel yang akan diterapkan saat membuat database ini.

Nama	Jenis	Deskripsi
AdventureWorksLT	string
WideWorldImportersFull	string
WideWorldImportersStd	string

SecondaryType

Jenis sekunder database jika merupakan sekunder. Nilai yang valid adalah Geo dan Named.

Nama	Jenis	Deskripsi
Geo	string
Named	string

Sku

SKU Sumber Daya ARM.

Nama	Jenis	Deskripsi
capacity	integer	Kapasitas SKU tertentu.
family	string	Jika layanan memiliki generasi perangkat keras yang berbeda, untuk SKU yang sama, maka itu dapat ditangkap di sini.
name	string	Nama SKU, biasanya, kode huruf + Angka, misalnya P3.
size	string	Ukuran SKU tertentu
tier	string	Tingkat atau edisi SKU tertentu, misalnya Dasar, Premium.

Bagikan melalui

Databases - List By Elastic Pool

Parameter URI

Respons

Contoh

Gets a list of databases in an elastic pool.

Permintaan sampel

Respon sampel

Definisi

BackupStorageRedundancy

CatalogCollationType

CreateMode

Database

DatabaseIdentity

DatabaseIdentityType

DatabaseLicenseType

DatabaseListResult

DatabaseReadScale

DatabaseStatus

DatabaseUserIdentity

SampleName

SecondaryType

Sku

Sumber Daya Tambahan: