Databases - Get

Hiermee haalt u een database op.

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

URI-parameters

Name In Required Type Description
databaseName
path True
  • string

De naam van de database.

resourceGroupName
path True
  • string

De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.

serverName
path True
  • string

De naam van de server.

subscriptionId
path True
  • string

De abonnements-id die een Azure-abonnement identificeert.

api-version
query True
  • string

De API-versie die moet worden gebruikt voor de aanvraag.

Antwoorden

Name Type Description
200 OK

De opgegeven database is opgehaald.

Other Status Codes

Foutreacties: **

  • 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden

  • 404 ServerNotInSubscriptionResourceGroup - opgegeven server bestaat niet in de opgegeven resourcegroep en het opgegeven abonnement.

  • 404 ResourceNotFound - De aangevraagde resource is niet gevonden.

Voorbeelden

Gets a database.

Sample Request

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

Sample Response

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

Definities

BackupStorageRedundancy

Het type opslagaccount dat wordt gebruikt voor het opslaan van back-ups voor deze database.

CatalogCollationType

Sortering van de metagegevenscatalogus.

CreateMode

Hiermee geeft u de modus voor het maken van de database op.

Standaard: het maken van een gewone database.

Kopiëren: maakt een database als een kopie van een bestaande database. sourceDatabaseId moet worden opgegeven als de resource-id van de brondatabase.

Secundair: maakt een database als een secundaire replica van een bestaande database. sourceDatabaseId moet worden opgegeven als de resource-id van de bestaande primaire database.

PointInTimeRestore: hiermee maakt u een database door een back-up naar een bepaald tijdstip van een bestaande database te herstellen. sourceDatabaseId moet worden opgegeven als de resource-id van de bestaande database en restorePointInTime moet worden opgegeven.

Herstel: Hiermee maakt u een database door een geo-gerepliceerde back-up te herstellen. sourceDatabaseId moet worden opgegeven als de herstelbare databaseresource-id om te herstellen.

Herstellen: Hiermee maakt u een database door een back-up van een verwijderde database te herstellen. sourceDatabaseId moet worden opgegeven. Als sourceDatabaseId de oorspronkelijke resource-id van de database is, moet sourceDatabaseDeletionDate worden opgegeven. Anders moet sourceDatabaseId de restorable verwijderde databaseresource-id zijn en sourceDatabaseDeletionDate wordt genegeerd. restorePointInTime kan ook worden opgegeven om te herstellen vanaf een eerder tijdstip.

RestoreLongTermRetentionBackup: hiermee maakt u een database door te herstellen vanuit een langetermijnretentiekluis. recoveryServicesRecoveryPointResourceId moet worden opgegeven als de resource-id van het herstelpunt.

Kopiëren, Secundair en RestoreLongTermRetentionBackup worden niet ondersteund voor de DataWarehouse-editie.

Database

Een databaseresource.

DatabaseIdentity

Azure Active Directory identiteitsconfiguratie voor een resource.

DatabaseIdentityType

Het identiteitstype

DatabaseLicenseType

Het licentietype dat moet worden aangevraagd voor deze database. LicenseIncludedals u een licentie nodig hebt of BasePrice als u een licentie hebt en in aanmerking komt voor de Azure Hybrid Benefit.

DatabaseReadScale

De status van alleen-lezenroutering. Als deze optie is ingeschakeld, kunnen verbindingen met de intentie van de toepassing worden ingesteld op alleen-lezen in hun verbindingsreeks worden doorgestuurd naar een alleen-lezen secundaire replica in dezelfde regio. Niet van toepassing op een Hyperscale-database binnen een elastische pool.

DatabaseStatus

De status van de database.

DatabaseUserIdentity

Azure Active Directory identiteitsconfiguratie voor een resource.

SampleName

De naam van het voorbeeldschema dat moet worden toegepast bij het maken van deze database.

SecondaryType

Het secundaire type van de database als het een secundaire database is. Geldige waarden zijn Geo en Benoemd.

Sku

Een ARM-resource-SKU.

BackupStorageRedundancy

Het type opslagaccount dat wordt gebruikt voor het opslaan van back-ups voor deze database.

Name Type Description
Geo
  • string
GeoZone
  • string
Local
  • string
Zone
  • string

CatalogCollationType

Sortering van de metagegevenscatalogus.

Name Type Description
DATABASE_DEFAULT
  • string
SQL_Latin1_General_CP1_CI_AS
  • string

CreateMode

Hiermee geeft u de modus voor het maken van de database op.

Standaard: het maken van een gewone database.

Kopiëren: maakt een database als een kopie van een bestaande database. sourceDatabaseId moet worden opgegeven als de resource-id van de brondatabase.

Secundair: maakt een database als een secundaire replica van een bestaande database. sourceDatabaseId moet worden opgegeven als de resource-id van de bestaande primaire database.

PointInTimeRestore: hiermee maakt u een database door een back-up naar een bepaald tijdstip van een bestaande database te herstellen. sourceDatabaseId moet worden opgegeven als de resource-id van de bestaande database en restorePointInTime moet worden opgegeven.

Herstel: Hiermee maakt u een database door een geo-gerepliceerde back-up te herstellen. sourceDatabaseId moet worden opgegeven als de herstelbare databaseresource-id om te herstellen.

Herstellen: Hiermee maakt u een database door een back-up van een verwijderde database te herstellen. sourceDatabaseId moet worden opgegeven. Als sourceDatabaseId de oorspronkelijke resource-id van de database is, moet sourceDatabaseDeletionDate worden opgegeven. Anders moet sourceDatabaseId de restorable verwijderde databaseresource-id zijn en sourceDatabaseDeletionDate wordt genegeerd. restorePointInTime kan ook worden opgegeven om te herstellen vanaf een eerder tijdstip.

RestoreLongTermRetentionBackup: hiermee maakt u een database door te herstellen vanuit een langetermijnretentiekluis. recoveryServicesRecoveryPointResourceId moet worden opgegeven als de resource-id van het herstelpunt.

Kopiëren, Secundair en RestoreLongTermRetentionBackup worden niet ondersteund voor de DataWarehouse-editie.

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

Database

Een databaseresource.

Name Type Description
id
  • string

Resource-id.

identity

De Azure Active Directory identiteit van de database.

kind
  • string

Soort database. Dit zijn metagegevens die worden gebruikt voor de Azure Portal ervaring.

location
  • string

Resourcelocatie.

managedBy
  • string

Resource waarmee de database wordt beheerd.

name
  • string

Resourcenaam.

properties.autoPauseDelay
  • integer

Tijd in minuten waarna de database automatisch wordt onderbroken. Een waarde van -1 betekent dat automatische pauze is uitgeschakeld

properties.catalogCollation

Sortering van de metagegevenscatalogus.

properties.collation
  • string

De sortering van de database.

properties.createMode

Hiermee geeft u de modus voor het maken van de database op.

Standaard: het maken van een gewone database.

Kopiëren: maakt een database als een kopie van een bestaande database. sourceDatabaseId moet worden opgegeven als de resource-id van de brondatabase.

Secundair: maakt een database als een secundaire replica van een bestaande database. sourceDatabaseId moet worden opgegeven als de resource-id van de bestaande primaire database.

PointInTimeRestore: hiermee maakt u een database door een back-up naar een bepaald tijdstip van een bestaande database te herstellen. sourceDatabaseId moet worden opgegeven als de resource-id van de bestaande database en restorePointInTime moet worden opgegeven.

Herstel: Hiermee maakt u een database door een geo-gerepliceerde back-up te herstellen. sourceDatabaseId moet worden opgegeven als de herstelbare databaseresource-id om te herstellen.

Herstellen: Hiermee maakt u een database door een back-up van een verwijderde database te herstellen. sourceDatabaseId moet worden opgegeven. Als sourceDatabaseId de oorspronkelijke resource-id van de database is, moet sourceDatabaseDeletionDate worden opgegeven. Anders moet sourceDatabaseId de restorable verwijderde databaseresource-id zijn en sourceDatabaseDeletionDate wordt genegeerd. restorePointInTime kan ook worden opgegeven om te herstellen vanaf een eerder tijdstip.

RestoreLongTermRetentionBackup: hiermee maakt u een database door te herstellen vanuit een langetermijnretentiekluis. recoveryServicesRecoveryPointResourceId moet worden opgegeven als de resource-id van het herstelpunt.

Kopiëren, Secundair en RestoreLongTermRetentionBackup worden niet ondersteund voor de DataWarehouse-editie.

properties.creationDate
  • string

De aanmaakdatum van de database (ISO8601-indeling).

properties.currentBackupStorageRedundancy

Het type opslagaccount dat wordt gebruikt voor het opslaan van back-ups voor deze database.

properties.currentServiceObjectiveName
  • string

De huidige naam van de serviceniveaudoelstelling van de database.

properties.currentSku

De naam en laag van de SKU.

properties.databaseId
  • string

De id van de database.

properties.defaultSecondaryLocation
  • string

De standaard secundaire regio voor deze database.

properties.earliestRestoreDate
  • string

Hiermee worden de vroegste begindatum en -tijd geregistreerd die beschikbaar zijn voor deze database (ISO8601-indeling).

properties.elasticPoolId
  • string

De resource-id van de elastische pool die deze database bevat.

properties.failoverGroupId
  • string

Resource-id van failovergroep waartoe deze database behoort.

properties.federatedClientId
  • string

De client-id die wordt gebruikt voor cmk-scenario voor meerdere tenants per database

properties.highAvailabilityReplicaCount
  • integer

Het aantal secundaire replica's dat is gekoppeld aan de database die wordt gebruikt om hoge beschikbaarheid te bieden. Niet van toepassing op een Hyperscale-database binnen een elastische pool.

properties.isInfraEncryptionEnabled
  • boolean

Infra-versleuteling is ingeschakeld voor deze database.

properties.isLedgerOn
  • boolean

Of deze database nu een grootboekdatabase is, wat betekent dat alle tabellen in de database grootboektabellen zijn. Opmerking: de waarde van deze eigenschap kan niet worden gewijzigd nadat de database is gemaakt.

properties.licenseType

Het licentietype dat moet worden aangevraagd voor deze database. LicenseIncludedals u een licentie nodig hebt of BasePrice als u een licentie hebt en in aanmerking komt voor de Azure Hybrid Benefit.

properties.longTermRetentionBackupResourceId
  • string

De resource-id van de langetermijnretentieback-up die is gekoppeld aan het maken van de bewerking van deze database.

properties.maintenanceConfigurationId
  • string

Configuratie-id voor onderhoud die is toegewezen aan de database. Deze configuratie definieert de periode waarop de onderhoudsupdates plaatsvinden.

properties.maxLogSizeBytes
  • integer

De maximale logboekgrootte voor deze database.

properties.maxSizeBytes
  • integer

De maximale grootte van de database uitgedrukt in bytes.

properties.minCapacity
  • number

Minimale capaciteit die de database altijd heeft toegewezen, indien niet onderbroken

properties.pausedDate
  • string

De datum waarop de database is onderbroken door gebruikersconfiguratie of -actie (ISO8601-indeling). Null als de database gereed is.

properties.readScale

De status van alleen-lezenroutering. Als deze optie is ingeschakeld, kunnen verbindingen met de intentie van de toepassing worden ingesteld op alleen-lezen in hun verbindingsreeks worden doorgestuurd naar een alleen-lezen secundaire replica in dezelfde regio. Niet van toepassing op een Hyperscale-database binnen een elastische pool.

properties.recoverableDatabaseId
  • string

De resource-id van de herstelbare database die is gekoppeld aan het maken van deze database.

properties.recoveryServicesRecoveryPointId
  • string

De resource-id van het herstelpunt dat is gekoppeld aan het maken van de bewerking van deze database.

properties.requestedBackupStorageRedundancy

Het type opslagaccount dat moet worden gebruikt voor het opslaan van back-ups voor deze database.

properties.requestedServiceObjectiveName
  • string

De aangevraagde serviceniveaudoelstellingnaam van de database.

properties.restorableDroppedDatabaseId
  • string

De resource-id van de restorable verwijderde database die is gekoppeld aan het maken van de bewerking van deze database.

properties.restorePointInTime
  • string

Hiermee geeft u het tijdstip (ISO8601-indeling) van de brondatabase op die wordt hersteld om de nieuwe database te maken.

properties.resumedDate
  • string

De datum waarop de database is hervat door gebruikersactie of databaseaanmelding (ISO8601-indeling). Null als de database is onderbroken.

properties.sampleName

De naam van het voorbeeldschema dat moet worden toegepast bij het maken van deze database.

properties.secondaryType

Het secundaire type van de database als het een secundaire database is. Geldige waarden zijn Geo en Benoemd.

properties.sourceDatabaseDeletionDate
  • string

Hiermee geeft u het tijdstip op waarop de database is verwijderd.

properties.sourceDatabaseId
  • string

De resource-id van de brondatabase die is gekoppeld aan het maken van deze database.

properties.sourceResourceId
  • string

De resource-id van de bron die is gekoppeld aan de maakbewerking van deze database.

Deze eigenschap wordt alleen ondersteund voor de DataWarehouse-editie en staat toe om te herstellen tussen abonnementen.

Wanneer sourceResourceId is opgegeven, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId en sourceDatabaseDeletionDate mag niet worden opgegeven en CreateMode moet PointInTimeRestore, Restore of Recover zijn.

Wanneer createMode PointInTimeRestore is, moet sourceResourceId de resource-id van de bestaande database of bestaande SQL-pool zijn en moet restorePointInTime worden opgegeven.

Wanneer createMode restore is, moet sourceResourceId de resource-id zijn van herstelbare verwijderde database of herstelbare verwijderde SQL-pool.

Wanneer createMode is Recover, moet sourceResourceId de resource-id van de herstelbare database of herstelbare SQL-pool zijn.

Wanneer het bronabonnement deel uitmaakt van een andere tenant dan het doelabonnement, moet de header x-ms-authorization-auxiliary een verificatietoken voor de brontenant bevatten. Zie de header x-ms-authorization-auxiliary voor meer informatie over de header 'x-ms-authorization-auxiliary'. https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant

properties.status

De status van de database.

properties.zoneRedundant
  • boolean

Of deze database nu zoneredundant is, wat betekent dat de replica's van deze database worden verdeeld over meerdere beschikbaarheidszones.

sku

De database-SKU.

De lijst met SKU's kan per regio en ondersteuningsaanbieding verschillen. Gebruik de REST API of een van de volgende opdrachten om de SKU-naam, laag/editie, familie en capaciteit te bepalen die beschikbaar zijn voor uw abonnement in een Azure-regio Capabilities_ListByLocation :

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

Resourcetags.

type
  • string

Resourcetype.

DatabaseIdentity

Azure Active Directory identiteitsconfiguratie voor een resource.

Name Type Description
tenantId
  • string

De Azure Active Directory tenant-id.

type

Het identiteitstype

userAssignedIdentities

De resource-id's van de door de gebruiker toegewezen identiteiten die moeten worden gebruikt

DatabaseIdentityType

Het identiteitstype

Name Type Description
None
  • string
UserAssigned
  • string

DatabaseLicenseType

Het licentietype dat moet worden aangevraagd voor deze database. LicenseIncludedals u een licentie nodig hebt of BasePrice als u een licentie hebt en in aanmerking komt voor de Azure Hybrid Benefit.

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

DatabaseReadScale

De status van alleen-lezenroutering. Als deze optie is ingeschakeld, kunnen verbindingen met de intentie van de toepassing worden ingesteld op alleen-lezen in hun verbindingsreeks worden doorgestuurd naar een alleen-lezen secundaire replica in dezelfde regio. Niet van toepassing op een Hyperscale-database binnen een elastische pool.

Name Type Description
Disabled
  • string
Enabled
  • string

DatabaseStatus

De status van de database.

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
Starting
  • string
Stopped
  • string
Stopping
  • string
Suspect
  • string

DatabaseUserIdentity

Azure Active Directory identiteitsconfiguratie voor een resource.

Name Type Description
clientId
  • string

De Azure Active Directory client-id.

principalId
  • string

De Azure Active Directory principal-id.

SampleName

De naam van het voorbeeldschema dat moet worden toegepast bij het maken van deze database.

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

SecondaryType

Het secundaire type van de database als het een secundaire database is. Geldige waarden zijn Geo en Benoemd.

Name Type Description
Geo
  • string
Named
  • string

Sku

Een ARM-resource-SKU.

Name Type Description
capacity
  • integer

Capaciteit van de specifieke SKU.

family
  • string

Als de service verschillende generaties hardware heeft, kan die voor dezelfde SKU hier worden vastgelegd.

name
  • string

De naam van de SKU, meestal een letter + cijfercode, bijvoorbeeld P3.

size
  • string

Grootte van de specifieke SKU

tier
  • string

De laag of editie van de specifieke SKU, bijvoorbeeld Basic, Premium.