Bagikan melalui

Databases - Get

  • Referensi
Layanan:
SQL Database
Versi API:
2023-08-01

Mendapatkan database.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}?api-version=2023-08-01
Dengan parameter opsional: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}?$expand={$expand}&$filter={$filter}&api-version=2023-08-01

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
databaseName
 path True

string

Nama database.
resourceGroupName
 path True

string

Nama grup sumber daya yang berisi sumber daya. Anda dapat memperoleh nilai ini dari API Azure Resource Manager 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 akan digunakan untuk permintaan tersebut.
$expand
 query

string

Sumber daya anak untuk disertakan dalam respons.
$filter
 query

string

Ekspresi filter OData yang memfilter elemen dalam koleksi.

Respons

Nama Jenis Deskripsi
200 OK

Database

Berhasil mengambil database yang ditentukan.
Other Status Codes

ErrorResponse

Respons Kesalahan: ***

  • 400 ManagedInstanceStoppingOrStopped - Operasi yang bertentangan dikirimkan saat instans dalam status berhenti/dihentikan

  • 400 ManagedInstanceStarting - Operasi bertentangan yang dikirimkan saat instans dalam status mulai

  • 404 ServerNotInSubscriptionResourceGroup - Server yang ditentukan tidak ada di grup sumber daya dan langganan yang ditentukan.

  • 404 SubscriptionDoesNotHaveServer - Server yang diminta tidak ditemukan

  • 404 ResourceNotFound - Sumber daya yang diminta tidak ditemukan.

Contoh

Gets a database configured with Default enclave type.
Gets a database configured with VBS enclave type.
Gets a database with Availability zone specified.
Gets a database with database level keys expanded.
Gets a database.

Gets a database configured with Default enclave type.

Permintaan sampel

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

Respon sampel

Kode status:
200 
{
  "sku": {
    "name": "BC_Gen5",
    "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_Gen5_2",
    "requestedServiceObjectiveName": "BC_Gen5_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",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 2
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false,
    "preferredEnclaveType": "Default"
  },
  "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"
}

Gets a database configured with VBS enclave type.

Permintaan sampel

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

Respon sampel

Kode status:
200 
{
  "sku": {
    "name": "BC_Gen5",
    "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_Gen5_2",
    "requestedServiceObjectiveName": "BC_Gen5_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",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 2
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false,
    "preferredEnclaveType": "VBS"
  },
  "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"
}

Gets a database with Availability zone specified.

Permintaan sampel

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

Respon sampel

Kode status:
200 
{
  "sku": {
    "name": "S0",
    "tier": "Standard",
    "capacity": 10
  },
  "kind": "v12.0,user",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 1073741824,
    "status": "Online",
    "currentSku": {
      "name": "Standard",
      "tier": "Standard",
      "capacity": 10
    },
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentBackupStorageRedundancy": "Geo",
    "currentServiceObjectiveName": "S0",
    "defaultSecondaryLocation": "North Europe",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "readScale": "Disabled",
    "requestedBackupStorageRedundancy": "Geo",
    "requestedServiceObjectiveName": "S0",
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "isLedgerOn": false,
    "availabilityZone": "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"
}

Gets a database with database level keys expanded.

Permintaan sampel

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?$expand=keys&api-version=2023-08-01

Respon sampel

Kode status:
200 
{
  "sku": {
    "name": "BC_Gen5",
    "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_Gen5_2",
    "requestedServiceObjectiveName": "BC_Gen5_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",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 2
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false,
    "keys": {
      "https://your-key-vault-name.vault.azure.net/yourKey/yourKeyVersion": {},
      "https://your-key-vault-name.vault.azure.net/yourKey2/yourKey2Version": {}
    },
    "encryptionProtector": "https://your-key-vault-name.vault.azure.net/yourKey/yourKeyVersion"
  },
  "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"
}

Gets a database.

Permintaan sampel

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

Respon sampel

Kode status:
200 
{
  "sku": {
    "name": "BC_Gen5",
    "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_Gen5_2",
    "requestedServiceObjectiveName": "BC_Gen5_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",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 2
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "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"
}

Definisi

Nama Deskripsi
AlwaysEncryptedEnclaveType

Jenis enklave yang diminta pada database yaitu enklave Default atau VBS.
AvailabilityZoneType

Menentukan zona ketersediaan tempat database disematkan.
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 menjadi ID sumber daya database yang dihilangkan dan sourceDatabaseDeletionDate yang dapat 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
DatabaseKey

Kunci tingkat database yang digunakan untuk enkripsi saat tidak aktif.
DatabaseKeyType

Jenis kunci database. Hanya nilai yang didukung adalah 'AzureKeyVault'.
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.
DatabaseReadScale

Status perutean baca-saja. Jika diaktifkan, koneksi yang memiliki niat aplikasi diatur ke readonly dalam string koneksinya 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.
ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.
ErrorDetail

Detail kesalahan.
ErrorResponse

Respons kesalahan
FreeLimitExhaustionBehavior

Menentukan perilaku ketika batas gratis bulanan habis untuk database gratis.

Jeda Otomatis: Database akan dijeda secara otomatis setelah kelelahan batas gratis selama sisa bulan.

BillForUsage: Database akan terus online setelah kelelahan batas gratis dan kelebihan biaya apa pun akan ditagih.
SampleName

Nama skema sampel yang akan diterapkan saat membuat database ini.
SecondaryType

Jenis database sekunder jika merupakan sekunder. Nilai yang valid adalah Geo, Bernama, dan Siaga.
Sku

SKU Sumber Daya ARM.

AlwaysEncryptedEnclaveType

Enumeration

Jenis enklave yang diminta pada database yaitu enklave Default atau VBS.

Nilai Deskripsi
Default
VBS

AvailabilityZoneType

Enumeration

Menentukan zona ketersediaan tempat database disematkan.

Nilai Deskripsi
1
2
3
NoPreference

BackupStorageRedundancy

Enumeration

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

Nilai Deskripsi
Geo
GeoZone
Local
Zone

CatalogCollationType

Enumeration

Kolate katalog metadata.

Nilai Deskripsi
DATABASE_DEFAULT
SQL_Latin1_General_CP1_CI_AS

CreateMode

Enumeration

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 menjadi ID sumber daya database yang dihilangkan dan sourceDatabaseDeletionDate yang dapat 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.

Nilai Deskripsi
Copy
Default
OnlineSecondary
PointInTimeRestore
Recovery
Restore
RestoreExternalBackup
RestoreExternalBackupSecondary
RestoreLongTermRetentionBackup
Secondary

Database

Objek

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 Microsoft Azure.
location

string

Lokasi sumber daya.
managedBy

string

Sumber daya yang mengelola database.
name

string

Nama sumber daya.
properties.autoPauseDelay

integer (int32)

Waktu dalam menit setelah database dijeda secara otomatis. Nilai -1 berarti jeda otomatis dinonaktifkan
properties.availabilityZone

AvailabilityZoneType

Menentukan zona ketersediaan tempat database disematkan.
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 menjadi ID sumber daya database yang dihilangkan dan sourceDatabaseDeletionDate yang dapat 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 (date-time)

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 (uuid)

ID database.
properties.defaultSecondaryLocation

string

Wilayah sekunder default untuk database ini.
properties.earliestRestoreDate

string (date-time)

Ini mencatat tanggal dan waktu mulai paling awal yang pemulihan tersedia untuk database ini (format ISO8601).
properties.elasticPoolId

string (arm-id)

Pengidentifikasi sumber daya kumpulan elastis yang berisi database ini.
properties.encryptionProtector

string

URI brankas kunci azure database jika dikonfigurasi dengan per Kunci Terkelola Pelanggan Database.
properties.encryptionProtectorAutoRotation

boolean

Bendera untuk mengaktifkan atau menonaktifkan rotasi otomatis kunci AKV pelindung enkripsi database.
properties.failoverGroupId

string

Pengidentifikasi sumber daya Grup Failover tempat database ini berada.
properties.federatedClientId

string (uuid)

Id Klien yang digunakan untuk skenario CMK lintas penyewa per database
properties.freeLimitExhaustionBehavior

FreeLimitExhaustionBehavior

Menentukan perilaku ketika batas gratis bulanan habis untuk database gratis.

Jeda Otomatis: Database akan dijeda secara otomatis setelah kelelahan batas gratis selama sisa bulan.

BillForUsage: Database akan terus online setelah kelelahan batas gratis dan kelebihan biaya apa pun akan ditagih.
properties.highAvailabilityReplicaCount

integer (int32)

Jumlah replika sekunder yang terkait dengan database edisi Business Critical, Premium, atau Hyperscale 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.keys

<string,  DatabaseKey>

Id sumber daya dari identitas yang ditetapkan pengguna untuk digunakan
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 (arm-id)

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

boolean

Apakah cutover manual yang dikontrol pelanggan perlu dilakukan selama operasi Pembaruan Database ke tingkat Hyperscale atau tidak.

Properti ini hanya berlaku saat menskalakan database dari tingkat Business Critical/General Purpose/Premium/Standard ke tingkat Hyperscale.

Ketika manualCutover ditentukan, operasi penskalaan akan menunggu input pengguna untuk memicu cutover ke database Hyperscale.

Untuk memicu cutover, harap berikan parameter 'performCutover' saat operasi Penskalaan dalam status Menunggu.
properties.maxLogSizeBytes

integer (int64)

Ukuran log maks untuk database ini.
properties.maxSizeBytes

integer (int64)

Ukuran maksimum database yang dinyatakan dalam byte.
properties.minCapacity

number (double)

Kapasitas minimal yang akan selalu dialokasikan database, jika tidak dijeda
properties.pausedDate

string (date-time)

Tanggal saat database dijeda oleh konfigurasi atau tindakan pengguna(format ISO8601). Null jika database sudah siap.
properties.performCutover

boolean

Untuk memicu cutover manual yang dikontrol pelanggan selama status tunggu saat operasi Penskalaan sedang berlangsung.

Parameter properti ini hanya berlaku untuk operasi penskalaan yang dimulai bersama dengan parameter 'manualCutover'.

Properti ini hanya berlaku saat penskalaan database dari tingkat Business Critical/General Purpose/Premium/Standard ke tingkat Hyperscale sudah berlangsung.

Ketika performCutover ditentukan, operasi penskalaan akan memicu cutover dan melakukan perubahan peran ke database Hyperscale.
properties.preferredEnclaveType

AlwaysEncryptedEnclaveType

Jenis enklave yang diminta pada database yaitu enklave Default atau VBS.
properties.readScale

DatabaseReadScale

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

string (arm-id)

Pengidentifikasi sumber daya database yang dapat dipulihkan yang terkait dengan operasi pembuatan database ini.
properties.recoveryServicesRecoveryPointId

string (arm-id)

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 yang diminta dari database.
properties.restorableDroppedDatabaseId

string (arm-id)

Pengidentifikasi sumber daya dari database yang dihilangkan yang dapat dihilangkan yang terkait dengan operasi pembuatan database ini.
properties.restorePointInTime

string (date-time)

Menentukan titik waktu (format ISO8601) database sumber yang akan dipulihkan untuk membuat database baru.
properties.resumedDate

string (date-time)

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 database sekunder jika merupakan sekunder. Nilai yang valid adalah Geo, Bernama, dan Siaga.
properties.sourceDatabaseDeletionDate

string (date-time)

Menentukan waktu database dihapus.
properties.sourceDatabaseId

string (arm-id)

Pengidentifikasi sumber daya database sumber yang terkait dengan operasi pembuatan database ini.
properties.sourceResourceId

string (arm-id)

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

boolean

Apakah database menggunakan batas bulanan gratis atau tidak. Diizinkan pada satu database dalam langganan.
properties.zoneRedundant

boolean

Apakah database ini redundan zona 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

Objek

Konfigurasi identitas Azure Active Directory untuk sumber daya.

Nama Jenis Deskripsi
tenantId

string (uuid)

Id penyewa Azure Active Directory.
type

DatabaseIdentityType

Jenis identitas
userAssignedIdentities

<string,  DatabaseUserIdentity>

Id sumber daya dari identitas yang ditetapkan pengguna untuk digunakan

DatabaseIdentityType

Enumeration

Jenis identitas

Nilai Deskripsi
None
UserAssigned

DatabaseKey

Objek

Kunci tingkat database yang digunakan untuk enkripsi saat tidak aktif.

Nama Jenis Deskripsi
creationDate

string (date-time)

Tanggal pembuatan kunci database.
subregion

string

Subregion kunci server.
thumbprint

string

Thumbprint kunci database.
type

DatabaseKeyType

Jenis kunci database. Hanya nilai yang didukung adalah 'AzureKeyVault'.

DatabaseKeyType

Enumeration

Jenis kunci database. Hanya nilai yang didukung adalah 'AzureKeyVault'.

Nilai Deskripsi
AzureKeyVault

DatabaseLicenseType

Enumeration

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.

Nilai Deskripsi
BasePrice
LicenseIncluded

DatabaseReadScale

Enumeration

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

Nilai Deskripsi
Disabled
Enabled

DatabaseStatus

Enumeration

Status database.

Nilai Deskripsi
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

Objek

Konfigurasi identitas Azure Active Directory untuk sumber daya.

Nama Jenis Deskripsi
clientId

string (uuid)

Id klien Azure Active Directory.
principalId

string (uuid)

Id utama Azure Active Directory.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama Jenis Deskripsi
info

object

Info tambahan.
type

string

Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama Jenis Deskripsi
additionalInfo

ErrorAdditionalInfo[]

Info tambahan kesalahan.
code

string

Kode kesalahan.
details

ErrorDetail[]

Detail kesalahan.
message

string

Pesan kesalahan.
target

string

Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

FreeLimitExhaustionBehavior

Enumeration

Menentukan perilaku ketika batas gratis bulanan habis untuk database gratis.

Jeda Otomatis: Database akan dijeda secara otomatis setelah kelelahan batas gratis selama sisa bulan.

BillForUsage: Database akan terus online setelah kelelahan batas gratis dan kelebihan biaya apa pun akan ditagih.

Nilai Deskripsi
AutoPause
BillOverUsage

SampleName

Enumeration

Nama skema sampel yang akan diterapkan saat membuat database ini.

Nilai Deskripsi
AdventureWorksLT
WideWorldImportersFull
WideWorldImportersStd

SecondaryType

Enumeration

Jenis database sekunder jika merupakan sekunder. Nilai yang valid adalah Geo, Bernama, dan Siaga.

Nilai Deskripsi
Geo
Named
Standby

Sku

Objek

SKU Sumber Daya ARM.

Nama Jenis Deskripsi
capacity

integer (int32)

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.