Freigeben über


Databases - Get

Ruft eine Datenbank ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}?api-version=2023-08-01
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

URI-Parameter

Name In Erforderlich Typ Beschreibung
databaseName
path True

string

Der Name der Datenbank.

resourceGroupName
path True

string

Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.

serverName
path True

string

Der Name des Servers.

subscriptionId
path True

string

Die Abonnement-ID, die ein Azure-Abonnement identifiziert.

api-version
query True

string

Die API-Version, die für die Anforderung verwendet werden soll.

$expand
query

string

Die untergeordneten Ressourcen, die in die Antwort eingeschlossen werden sollen.

$filter
query

string

Ein OData-Filterausdruck, der Elemente in der Auflistung filtert.

Antworten

Name Typ Beschreibung
200 OK

Database

Die angegebene Datenbank wurde erfolgreich abgerufen.

Other Status Codes

ErrorResponse

Fehlerantworten: ***

  • 400 ManagedInstanceStoppingOrStopped – Konfliktierender Vorgang, der während der Instanz beendet/beendet wird

  • 400 ManagedInstanceStarting – Konfliktierender Vorgang, der während der Instanz im Startzustand liegt

  • 404 ServerNotInSubscriptionResourceGroup – Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden.

  • 404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden.

  • 404 ResourceNotFound – Die angeforderte Ressource wurde nicht gefunden.

Beispiele

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.

Beispielanforderung

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

Beispiel für eine Antwort

{
  "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.

Beispielanforderung

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

Beispiel für eine Antwort

{
  "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.

Beispielanforderung

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

Beispiel für eine Antwort

{
  "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.

Beispielanforderung

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

Beispiel für eine Antwort

{
  "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.

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
AlwaysEncryptedEnclaveType

Typ der in der Datenbank angeforderten Enklave, d. h. Standard- oder VBS-Enklaven.

AvailabilityZoneType

Gibt die Verfügbarkeitszone an, an die die Datenbank angeheftet ist.

BackupStorageRedundancy

Der Speicherkontotyp, der zum Speichern von Sicherungen für diese Datenbank verwendet wird.

CatalogCollationType

Sortierung des Metadatenkatalogs.

CreateMode

Gibt den Modus der Datenbankerstellung an.

Standard: regelmäßige Datenbankerstellung.

Kopie: Erstellt eine Datenbank als Kopie einer vorhandenen Datenbank. sourceDatabaseId muss als Ressourcen-ID der Quelldatenbank angegeben werden.

Sekundär: Erstellt eine Datenbank als sekundäres Replikat einer vorhandenen Datenbank. sourceDatabaseId muss als Ressourcen-ID der vorhandenen primären Datenbank angegeben werden.

PointInTimeRestore: Erstellt eine Datenbank durch Wiederherstellen einer Zeitsicherung einer vorhandenen Datenbank. "sourceDatabaseId" muss als Ressourcen-ID der vorhandenen Datenbank angegeben werden, und "restorePointInTime" muss angegeben werden.

Wiederherstellung: Erstellt eine Datenbank, indem eine georeplizierte Sicherung wiederhergestellt wird. sourceDatabaseId muss als wiederherstellbare Datenbankressourcen-ID angegeben werden, um wiederherzustellen.

Wiederherstellen: Erstellt eine Datenbank durch Wiederherstellen einer Sicherung einer gelöschten Datenbank. sourceDatabaseId muss angegeben werden. Wenn "sourceDatabaseId" die ursprüngliche Ressourcen-ID der Datenbank ist, muss "sourceDatabaseDeletionDate" angegeben werden. Andernfalls muss "sourceDatabaseId" die wiederherstellbare verworfene Datenbankressourcen-ID sein, und "sourceDatabaseDeletionDate" wird ignoriert. restorePointInTime kann auch angegeben werden, um sie von einem früheren Zeitpunkt wiederherzustellen.

RestoreLongTermRetentionBackup: Erstellt eine Datenbank, indem sie aus einem langfristigen Aufbewahrungstresor wiederhergestellt wird. recoveryServicesRecoveryPointResourceId muss als Ressourcen-ID des Wiederherstellungspunkts angegeben werden.

Copy, Secondary und RestoreLongTermRetentionBackup werden für DataWarehouse Edition nicht unterstützt.

Database

Eine Datenbankressource.

DatabaseIdentity

Azure Active Directory-Identitätskonfiguration für eine Ressource.

DatabaseIdentityType

Der Identitätstyp

DatabaseKey

Schlüssel auf Datenbankebene, der für die Verschlüsselung ruhender Daten verwendet wird.

DatabaseKeyType

Der Datenbankschlüsseltyp. Nur unterstützter Wert ist "AzureKeyVault".

DatabaseLicenseType

Der lizenztyp, der für diese Datenbank gilt. LicenseIncluded, wenn Sie eine Lizenz benötigen, oder BasePrice, wenn Sie über eine Lizenz verfügen und für den Azure-Hybridvorteil berechtigt sind.

DatabaseReadScale

Der Status des schreibgeschützten Routings. Wenn diese Option aktiviert ist, werden Verbindungen, für die die Anwendungsabsicht in ihrer Verbindungszeichenfolge festgelegt ist, möglicherweise an ein readonly sekundäres Replikat in derselben Region weitergeleitet. Gilt nicht für eine Hyperscale-Datenbank innerhalb eines elastischen Pools.

DatabaseStatus

Der Status der Datenbank.

DatabaseUserIdentity

Azure Active Directory-Identitätskonfiguration für eine Ressource.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Fehlerantwort

FreeLimitExhaustionBehavior

Gibt das Verhalten an, wenn monatliche kostenlose Grenzwerte für die kostenlose Datenbank erschöpft sind.

AutoPause: Die Datenbank wird automatisch angehalten, wenn die freien Grenzwerte für den Rest des Monats erschöpft sind.

BillForUsage: Die Datenbank wird weiterhin online sein, wenn die freien Grenzwerte erschöpft sind, und jegliche Überlastung wird in Rechnung gestellt.

SampleName

Der Name des Beispielschemas, das beim Erstellen dieser Datenbank angewendet werden soll.

SecondaryType

Der sekundäre Typ der Datenbank, wenn es sich um eine sekundäre Datenbank handelt. Gültige Werte sind Geo, Named and Standby.

Sku

Eine ARM-Ressourcen-SKU.

AlwaysEncryptedEnclaveType

Typ der in der Datenbank angeforderten Enklave, d. h. Standard- oder VBS-Enklaven.

Wert Beschreibung
Default
VBS

AvailabilityZoneType

Gibt die Verfügbarkeitszone an, an die die Datenbank angeheftet ist.

Wert Beschreibung
1
2
3
NoPreference

BackupStorageRedundancy

Der Speicherkontotyp, der zum Speichern von Sicherungen für diese Datenbank verwendet wird.

Wert Beschreibung
Geo
GeoZone
Local
Zone

CatalogCollationType

Sortierung des Metadatenkatalogs.

Wert Beschreibung
DATABASE_DEFAULT
SQL_Latin1_General_CP1_CI_AS

CreateMode

Gibt den Modus der Datenbankerstellung an.

Standard: regelmäßige Datenbankerstellung.

Kopie: Erstellt eine Datenbank als Kopie einer vorhandenen Datenbank. sourceDatabaseId muss als Ressourcen-ID der Quelldatenbank angegeben werden.

Sekundär: Erstellt eine Datenbank als sekundäres Replikat einer vorhandenen Datenbank. sourceDatabaseId muss als Ressourcen-ID der vorhandenen primären Datenbank angegeben werden.

PointInTimeRestore: Erstellt eine Datenbank durch Wiederherstellen einer Zeitsicherung einer vorhandenen Datenbank. "sourceDatabaseId" muss als Ressourcen-ID der vorhandenen Datenbank angegeben werden, und "restorePointInTime" muss angegeben werden.

Wiederherstellung: Erstellt eine Datenbank, indem eine georeplizierte Sicherung wiederhergestellt wird. sourceDatabaseId muss als wiederherstellbare Datenbankressourcen-ID angegeben werden, um wiederherzustellen.

Wiederherstellen: Erstellt eine Datenbank durch Wiederherstellen einer Sicherung einer gelöschten Datenbank. sourceDatabaseId muss angegeben werden. Wenn "sourceDatabaseId" die ursprüngliche Ressourcen-ID der Datenbank ist, muss "sourceDatabaseDeletionDate" angegeben werden. Andernfalls muss "sourceDatabaseId" die wiederherstellbare verworfene Datenbankressourcen-ID sein, und "sourceDatabaseDeletionDate" wird ignoriert. restorePointInTime kann auch angegeben werden, um sie von einem früheren Zeitpunkt wiederherzustellen.

RestoreLongTermRetentionBackup: Erstellt eine Datenbank, indem sie aus einem langfristigen Aufbewahrungstresor wiederhergestellt wird. recoveryServicesRecoveryPointResourceId muss als Ressourcen-ID des Wiederherstellungspunkts angegeben werden.

Copy, Secondary und RestoreLongTermRetentionBackup werden für DataWarehouse Edition nicht unterstützt.

Wert Beschreibung
Copy
Default
OnlineSecondary
PointInTimeRestore
Recovery
Restore
RestoreExternalBackup
RestoreExternalBackupSecondary
RestoreLongTermRetentionBackup
Secondary

Database

Eine Datenbankressource.

Name Typ Beschreibung
id

string

Ressourcen-ID.

identity

DatabaseIdentity

Die Azure Active Directory-Identität der Datenbank.

kind

string

Art der Datenbank. Dies sind Metadaten, die für die Azure-Portaloberfläche verwendet werden.

location

string

Ressourcenspeicherort.

managedBy

string

Ressource, die die Datenbank verwaltet.

name

string

Ressourcenname.

properties.autoPauseDelay

integer (int32)

Die Zeit in Minuten, nach der die Datenbank automatisch angehalten wird. Ein Wert von -1 bedeutet, dass die automatische Pause deaktiviert ist.

properties.availabilityZone

AvailabilityZoneType

Gibt die Verfügbarkeitszone an, an die die Datenbank angeheftet ist.

properties.catalogCollation

CatalogCollationType

Sortierung des Metadatenkatalogs.

properties.collation

string

Die Sortierung der Datenbank.

properties.createMode

CreateMode

Gibt den Modus der Datenbankerstellung an.

Standard: regelmäßige Datenbankerstellung.

Kopie: Erstellt eine Datenbank als Kopie einer vorhandenen Datenbank. sourceDatabaseId muss als Ressourcen-ID der Quelldatenbank angegeben werden.

Sekundär: Erstellt eine Datenbank als sekundäres Replikat einer vorhandenen Datenbank. sourceDatabaseId muss als Ressourcen-ID der vorhandenen primären Datenbank angegeben werden.

PointInTimeRestore: Erstellt eine Datenbank durch Wiederherstellen einer Zeitsicherung einer vorhandenen Datenbank. "sourceDatabaseId" muss als Ressourcen-ID der vorhandenen Datenbank angegeben werden, und "restorePointInTime" muss angegeben werden.

Wiederherstellung: Erstellt eine Datenbank, indem eine georeplizierte Sicherung wiederhergestellt wird. sourceDatabaseId muss als wiederherstellbare Datenbankressourcen-ID angegeben werden, um wiederherzustellen.

Wiederherstellen: Erstellt eine Datenbank durch Wiederherstellen einer Sicherung einer gelöschten Datenbank. sourceDatabaseId muss angegeben werden. Wenn "sourceDatabaseId" die ursprüngliche Ressourcen-ID der Datenbank ist, muss "sourceDatabaseDeletionDate" angegeben werden. Andernfalls muss "sourceDatabaseId" die wiederherstellbare verworfene Datenbankressourcen-ID sein, und "sourceDatabaseDeletionDate" wird ignoriert. restorePointInTime kann auch angegeben werden, um sie von einem früheren Zeitpunkt wiederherzustellen.

RestoreLongTermRetentionBackup: Erstellt eine Datenbank, indem sie aus einem langfristigen Aufbewahrungstresor wiederhergestellt wird. recoveryServicesRecoveryPointResourceId muss als Ressourcen-ID des Wiederherstellungspunkts angegeben werden.

Copy, Secondary und RestoreLongTermRetentionBackup werden für DataWarehouse Edition nicht unterstützt.

properties.creationDate

string (date-time)

Das Erstellungsdatum der Datenbank (ISO8601 Format).

properties.currentBackupStorageRedundancy

BackupStorageRedundancy

Der Speicherkontotyp, der zum Speichern von Sicherungen für diese Datenbank verwendet wird.

properties.currentServiceObjectiveName

string

Der aktuelle Zielname der Dienstebene der Datenbank.

properties.currentSku

Sku

Der Name und die Ebene der SKU.

properties.databaseId

string (uuid)

Die ID der Datenbank.

properties.defaultSecondaryLocation

string

Der sekundäre Standardbereich für diese Datenbank.

properties.earliestRestoreDate

string (date-time)

Dadurch wird das früheste Startdatum und die früheste Wiederherstellungszeit für diese Datenbank (ISO8601 Format) aufgezeichnet.

properties.elasticPoolId

string (arm-id)

Der Ressourcenbezeichner des elastischen Pools, der diese Datenbank enthält.

properties.encryptionProtector

string

Der Azure Key Vault-URI der Datenbank, wenn er mit den vom Kunden verwalteten Datenbankschlüsseln konfiguriert ist.

properties.encryptionProtectorAutoRotation

boolean

Das Kennzeichen zum Aktivieren oder Deaktivieren der automatischen Drehung des AKV-Schlüssels der Datenbankverschlüsselungskomponente.

properties.failoverGroupId

string

Failovergruppenressourcenbezeichner, zu dem diese Datenbank gehört.

properties.federatedClientId

string (uuid)

Client-ID, die für mandantenübergreifendes CMK-Szenario verwendet wird

properties.freeLimitExhaustionBehavior

FreeLimitExhaustionBehavior

Gibt das Verhalten an, wenn monatliche kostenlose Grenzwerte für die kostenlose Datenbank erschöpft sind.

AutoPause: Die Datenbank wird automatisch angehalten, wenn die freien Grenzwerte für den Rest des Monats erschöpft sind.

BillForUsage: Die Datenbank wird weiterhin online sein, wenn die freien Grenzwerte erschöpft sind, und jegliche Überlastung wird in Rechnung gestellt.

properties.highAvailabilityReplicaCount

integer (int32)

Die Anzahl der sekundären Replikate, die der Business Critical-, Premium- oder Hyperscale-Edition-Datenbank zugeordnet sind, die verwendet werden, um hohe Verfügbarkeit bereitzustellen. Gilt nicht für eine Hyperscale-Datenbank innerhalb eines elastischen Pools.

properties.isInfraEncryptionEnabled

boolean

Die Infrastrukturverschlüsselung ist für diese Datenbank aktiviert.

properties.isLedgerOn

boolean

Ob es sich bei dieser Datenbank um eine Ledgerdatenbank handelt, was bedeutet, dass alle Tabellen in der Datenbank Sachtabellen sind. Hinweis: Der Wert dieser Eigenschaft kann nicht geändert werden, nachdem die Datenbank erstellt wurde.

properties.keys

<string,  DatabaseKey>

Die Ressourcen-IDs der vom Benutzer zugewiesenen Identitäten, die verwendet werden sollen

properties.licenseType

DatabaseLicenseType

Der lizenztyp, der für diese Datenbank gilt. LicenseIncluded, wenn Sie eine Lizenz benötigen, oder BasePrice, wenn Sie über eine Lizenz verfügen und für den Azure-Hybridvorteil berechtigt sind.

properties.longTermRetentionBackupResourceId

string (arm-id)

Der Ressourcenbezeichner der langfristigen Aufbewahrungssicherung, die dem Erstellungsvorgang dieser Datenbank zugeordnet ist.

properties.maintenanceConfigurationId

string

Der Datenbank zugewiesene Wartungskonfigurations-ID. Diese Konfiguration definiert den Zeitraum, in dem die Wartungsupdates auftreten.

properties.manualCutover

boolean

Unabhängig davon, ob die vom Kunden kontrollierte manuelle Übernahme während des Aktualisierungsdatenbankvorgangs auf die Hyperscale-Ebene erfolgen muss.

Diese Eigenschaft gilt nur beim Skalieren der Datenbank von Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier.

Wenn "manualCutover" angegeben ist, wartet der Skalierungsvorgang auf die Benutzereingabe, um den Übernahmevorgang in die Hyperscale-Datenbank auszulösen.

Um den Übernahmevorgang auszulösen, geben Sie bitte den Parameter "performCutover" an, wenn der Skalierungsvorgang im Wartezustand liegt.

properties.maxLogSizeBytes

integer (int64)

Die maximale Protokollgröße für diese Datenbank.

properties.maxSizeBytes

integer (int64)

Die maximale Größe der Datenbank, die in Byte ausgedrückt wird.

properties.minCapacity

number (double)

Minimale Kapazität, die die Datenbank immer zugewiesen hat, wenn sie nicht angehalten wird

properties.pausedDate

string (date-time)

Das Datum, an dem die Datenbank durch die Benutzerkonfiguration oder -aktion (ISO8601 Format) angehalten wurde. Null, wenn die Datenbank bereit ist.

properties.performCutover

boolean

Um den vom Kunden gesteuerten manuellen Übernahmevorgang während des Wartezustands auszulösen, während der Skalierungsvorgang ausgeführt wird.

Dieser Eigenschaftsparameter gilt nur für Skalierungsvorgänge, die zusammen mit dem Parameter "manualCutover" initiiert werden.

Diese Eigenschaft gilt nur, wenn die Skalierungsdatenbank von Business Critical/General Purpose/Premium/Standard-Stufe auf Hyperscale-Ebene bereits ausgeführt wird.

Wenn "performCutover" angegeben ist, löst der Skalierungsvorgang den Übernahmevorgang aus und führt eine Rollenänderung in der Hyperscale-Datenbank aus.

properties.preferredEnclaveType

AlwaysEncryptedEnclaveType

Typ der in der Datenbank angeforderten Enklave, d. h. Standard- oder VBS-Enklaven.

properties.readScale

DatabaseReadScale

Der Status des schreibgeschützten Routings. Wenn diese Option aktiviert ist, werden Verbindungen, für die die Anwendungsabsicht in ihrer Verbindungszeichenfolge festgelegt ist, möglicherweise an ein readonly sekundäres Replikat in derselben Region weitergeleitet. Gilt nicht für eine Hyperscale-Datenbank innerhalb eines elastischen Pools.

properties.recoverableDatabaseId

string (arm-id)

Der Ressourcenbezeichner der wiederherstellbaren Datenbank, die dem Erstellungsvorgang dieser Datenbank zugeordnet ist.

properties.recoveryServicesRecoveryPointId

string (arm-id)

Der Ressourcenbezeichner des Wiederherstellungspunkts, der dem Erstellungsvorgang dieser Datenbank zugeordnet ist.

properties.requestedBackupStorageRedundancy

BackupStorageRedundancy

Der Speicherkontotyp, der zum Speichern von Sicherungen für diese Datenbank verwendet werden soll.

properties.requestedServiceObjectiveName

string

Der angeforderte Zielname der Dienstebene der Datenbank.

properties.restorableDroppedDatabaseId

string (arm-id)

Der Ressourcenbezeichner der wiederherstellbaren verworfenen Datenbank, die dem Erstellungsvorgang dieser Datenbank zugeordnet ist.

properties.restorePointInTime

string (date-time)

Gibt den Zeitpunkt (ISO8601 Format) der Quelldatenbank an, die wiederhergestellt wird, um die neue Datenbank zu erstellen.

properties.resumedDate

string (date-time)

Das Datum, an dem die Datenbank durch Benutzeraktion oder Datenbankanmeldung (ISO8601 Format) fortgesetzt wurde. Null, wenn die Datenbank angehalten wird.

properties.sampleName

SampleName

Der Name des Beispielschemas, das beim Erstellen dieser Datenbank angewendet werden soll.

properties.secondaryType

SecondaryType

Der sekundäre Typ der Datenbank, wenn es sich um eine sekundäre Datenbank handelt. Gültige Werte sind Geo, Named and Standby.

properties.sourceDatabaseDeletionDate

string (date-time)

Gibt die Uhrzeit an, zu der die Datenbank gelöscht wurde.

properties.sourceDatabaseId

string (arm-id)

Der Ressourcenbezeichner der Quelldatenbank, die dem Erstellungsvorgang dieser Datenbank zugeordnet ist.

properties.sourceResourceId

string (arm-id)

Der Ressourcenbezeichner der Quelle, die dem Erstellungsvorgang dieser Datenbank zugeordnet ist.

Diese Eigenschaft wird nur für DataWarehouse Edition unterstützt und ermöglicht die Wiederherstellung über Abonnements hinweg.

Wenn "sourceResourceId" angegeben ist, darf "sourceDatabaseId", "recoverableDatabaseId", "restoreableDroppedDatabaseId" und "sourceDatabaseDeletionDate" nicht angegeben werden, und "CreateMode" muss "PointInTimeRestore", "Restore" oder "Recover" sein.

Wenn createMode PointInTimeRestore ist, muss sourceResourceId die Ressourcen-ID der vorhandenen Datenbank oder des vorhandenen SQL-Pools sein, und restorePointInTime muss angegeben werden.

Wenn createMode wiederhergestellt wird, muss sourceResourceId die Ressourcen-ID der wiederherstellbaren gelöschten Datenbank oder des wiederherstellbaren gelöschten SQL-Pools sein.

Wenn createMode wiederhergestellt wird, muss sourceResourceId die Ressourcen-ID der wiederherstellbaren Datenbank oder des wiederherstellbaren SQL-Pools sein.

Wenn das Quellabonnement zu einem anderen Mandanten als dem Zielabonnement gehört, muss der Header "x-ms-authorization-auxiliary" Authentifizierungstoken für den Quellmandanten enthalten. Weitere Informationen zum Header "x-ms-authorization-auxiliary" finden Sie unter https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant

properties.status

DatabaseStatus

Der Status der Datenbank.

properties.useFreeLimit

boolean

Gibt an, ob die Datenbank kostenlose monatliche Grenzwerte verwendet. In einer Datenbank in einem Abonnement zulässig.

properties.zoneRedundant

boolean

Gibt an, ob diese Datenbank zonenredundant ist, was bedeutet, dass die Replikate dieser Datenbank über mehrere Verfügbarkeitszonen verteilt werden.

sku

Sku

Die Datenbank-SKU.

Die Liste der SKUs kann je nach Region und Supportangebot variieren. Um die SKUs (einschließlich SKU-Name, Tier/Edition, Familie und Kapazität) zu ermitteln, die für Ihr Abonnement in einer Azure-Region verfügbar sind, verwenden Sie die Capabilities_ListByLocation REST-API oder einen der folgenden Befehle:

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
tags

object

Ressourcentags.

type

string

Ressourcentyp.

DatabaseIdentity

Azure Active Directory-Identitätskonfiguration für eine Ressource.

Name Typ Beschreibung
tenantId

string (uuid)

Die Azure Active Directory-Mandanten-ID.

type

DatabaseIdentityType

Der Identitätstyp

userAssignedIdentities

<string,  DatabaseUserIdentity>

Die Ressourcen-IDs der vom Benutzer zugewiesenen Identitäten, die verwendet werden sollen

DatabaseIdentityType

Der Identitätstyp

Wert Beschreibung
None
UserAssigned

DatabaseKey

Schlüssel auf Datenbankebene, der für die Verschlüsselung ruhender Daten verwendet wird.

Name Typ Beschreibung
creationDate

string (date-time)

Das Erstellungsdatum des Datenbankschlüssels.

subregion

string

Unterregion des Serverschlüssels.

thumbprint

string

Fingerabdruck des Datenbankschlüssels.

type

DatabaseKeyType

Der Datenbankschlüsseltyp. Nur unterstützter Wert ist "AzureKeyVault".

DatabaseKeyType

Der Datenbankschlüsseltyp. Nur unterstützter Wert ist "AzureKeyVault".

Wert Beschreibung
AzureKeyVault

DatabaseLicenseType

Der lizenztyp, der für diese Datenbank gilt. LicenseIncluded, wenn Sie eine Lizenz benötigen, oder BasePrice, wenn Sie über eine Lizenz verfügen und für den Azure-Hybridvorteil berechtigt sind.

Wert Beschreibung
BasePrice
LicenseIncluded

DatabaseReadScale

Der Status des schreibgeschützten Routings. Wenn diese Option aktiviert ist, werden Verbindungen, für die die Anwendungsabsicht in ihrer Verbindungszeichenfolge festgelegt ist, möglicherweise an ein readonly sekundäres Replikat in derselben Region weitergeleitet. Gilt nicht für eine Hyperscale-Datenbank innerhalb eines elastischen Pools.

Wert Beschreibung
Disabled
Enabled

DatabaseStatus

Der Status der Datenbank.

Wert Beschreibung
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

Azure Active Directory-Identitätskonfiguration für eine Ressource.

Name Typ Beschreibung
clientId

string (uuid)

Die Azure Active Directory-Client-ID.

principalId

string (uuid)

Die Azure Active Directory-Prinzipal-ID.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

FreeLimitExhaustionBehavior

Gibt das Verhalten an, wenn monatliche kostenlose Grenzwerte für die kostenlose Datenbank erschöpft sind.

AutoPause: Die Datenbank wird automatisch angehalten, wenn die freien Grenzwerte für den Rest des Monats erschöpft sind.

BillForUsage: Die Datenbank wird weiterhin online sein, wenn die freien Grenzwerte erschöpft sind, und jegliche Überlastung wird in Rechnung gestellt.

Wert Beschreibung
AutoPause
BillOverUsage

SampleName

Der Name des Beispielschemas, das beim Erstellen dieser Datenbank angewendet werden soll.

Wert Beschreibung
AdventureWorksLT
WideWorldImportersFull
WideWorldImportersStd

SecondaryType

Der sekundäre Typ der Datenbank, wenn es sich um eine sekundäre Datenbank handelt. Gültige Werte sind Geo, Named and Standby.

Wert Beschreibung
Geo
Named
Standby

Sku

Eine ARM-Ressourcen-SKU.

Name Typ Beschreibung
capacity

integer (int32)

Kapazität der jeweiligen SKU.

family

string

Wenn der Dienst über unterschiedliche Hardwaregenerationen verfügt, kann dies für dieselbe SKU hier erfasst werden.

name

string

Der Name der SKU, in der Regel ein Buchstabe + Zahlencode, z. B. P3.

size

string

Größe der jeweiligen SKU

tier

string

Die Stufe oder Edition der jeweiligen SKU, z. B. Basic, Premium.