Databases - Get

  • Reference
Služba:
SQL Database
Verze rozhraní API:
2021-11-01

Získá databázi.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
databaseName
 path True

string

Název databáze.
resourceGroupName
 path True

string

Název skupiny prostředků, která prostředek obsahuje. Tuto hodnotu můžete získat z rozhraní API Resource Manager Azure nebo z portálu.
serverName
 path True

string

Název serveru.
subscriptionId
 path True

string

ID předplatného, které identifikuje předplatné Azure.
api-version
 query True

string

Verze rozhraní API, která se má použít pro požadavek.

Odpovědi

Name Typ Description
200 OK

Database

Zadaná databáze se úspěšně načetla.
Other Status Codes

Chybové odpovědi: ***

  • 404 SubscriptionDoesNotHaveServer – Požadovaný server se nenašel.

  • 404 ServerNotInSubscriptionResourceGroup – zadaný server v zadané skupině prostředků a předplatném neexistuje.

  • 404 ResourceNotFound – Požadovaný prostředek se nenašel.

Příklady

Gets a database.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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"
}

Definice

Name Description
BackupStorageRedundancy

Typ účtu úložiště, který slouží k ukládání záloh pro tuto databázi.
CatalogCollationType

Kolace katalogu metadat.
CreateMode

Určuje režim vytváření databáze.

Výchozí: pravidelné vytváření databáze.

Kopírování: Vytvoří databázi jako kopii existující databáze. sourceDatabaseId musí být zadané jako ID prostředku zdrojové databáze.

Sekundární: Vytvoří databázi jako sekundární repliku existující databáze. sourceDatabaseId musí být zadané jako ID prostředku existující primární databáze.

PointInTimeRestore: Vytvoří databázi obnovením zálohy existující databáze k určitému bodu v čase. SourceDatabaseId musí být zadáno jako ID prostředku existující databáze a musí být zadán parametr restorePointInTime.

Obnovení: Vytvoří databázi obnovením geograficky replikované zálohy. SourceDatabaseId musí být zadané jako ID obnovitelného prostředku databáze, které se má obnovit.

Obnovení: Vytvoří databázi obnovením zálohy odstraněné databáze. Musí být zadán sourceDatabaseId. Pokud sourceDatabaseId je ID původního prostředku databáze, musí být zadán sourceDatabaseDeletionDate. Jinak musí být sourceDatabaseId ID obnovitelného vyřazeného prostředku databáze a sourceDatabaseDeletionDate se ignoruje. parametr restorePointInTime může být také určen pro obnovení z dřívějšího bodu v čase.

RestoreLongTermRetentionBackup: Vytvoří databázi obnovením z trezoru dlouhodobého uchovávání. recoveryServicesRecoveryPointResourceId musí být zadané jako ID prostředku bodu obnovení.

Edice DataWarehouse nepodporují kopírování, sekundární a restoreLongTermRetentionBackup.
Database

Prostředek databáze.
DatabaseIdentity

Konfigurace identity Azure Active Directory pro prostředek
DatabaseIdentityType

Typ identity
DatabaseLicenseType

Typ licence, která se má vztahovat na tuto databázi. LicenseIncludedpokud potřebujete licenci nebo BasePrice pokud máte licenci a máte nárok na Zvýhodněné hybridní využití Azure.
DatabaseReadScale

Stav směrování jen pro čtení. Pokud je tato možnost povolená, připojení, která mají v připojovací řetězec záměr aplikace nastavený na jen pro čtení, se můžou směrovat na sekundární repliku jen pro čtení ve stejné oblasti. Nevztahuje se na databázi Hyperscale v rámci elastického fondu.
DatabaseStatus

Stav databáze.
DatabaseUserIdentity

Konfigurace identity Azure Active Directory pro prostředek
SampleName

Název ukázkového schématu, které se má použít při vytváření této databáze.
SecondaryType

Sekundární typ databáze, pokud se jedná o sekundární databázi. Platné hodnoty jsou Geo (Geografická oblast) a Named (Pojmenované).
Sku

Skladová položka prostředku ARM.

BackupStorageRedundancy

Typ účtu úložiště, který slouží k ukládání záloh pro tuto databázi.

Name Typ Description
Geo

string

GeoZone

string

Local

string

Zone

string

CatalogCollationType

Kolace katalogu metadat.

Name Typ Description
DATABASE_DEFAULT

string

SQL_Latin1_General_CP1_CI_AS

string

CreateMode

Určuje režim vytváření databáze.

Výchozí: pravidelné vytváření databáze.

Kopírování: Vytvoří databázi jako kopii existující databáze. sourceDatabaseId musí být zadané jako ID prostředku zdrojové databáze.

Sekundární: Vytvoří databázi jako sekundární repliku existující databáze. sourceDatabaseId musí být zadané jako ID prostředku existující primární databáze.

PointInTimeRestore: Vytvoří databázi obnovením zálohy existující databáze k určitému bodu v čase. SourceDatabaseId musí být zadáno jako ID prostředku existující databáze a musí být zadán parametr restorePointInTime.

Obnovení: Vytvoří databázi obnovením geograficky replikované zálohy. SourceDatabaseId musí být zadané jako ID obnovitelného prostředku databáze, které se má obnovit.

Obnovení: Vytvoří databázi obnovením zálohy odstraněné databáze. Musí být zadán sourceDatabaseId. Pokud sourceDatabaseId je ID původního prostředku databáze, musí být zadán sourceDatabaseDeletionDate. Jinak musí být sourceDatabaseId ID obnovitelného vyřazeného prostředku databáze a sourceDatabaseDeletionDate se ignoruje. parametr restorePointInTime může být také určen pro obnovení z dřívějšího bodu v čase.

RestoreLongTermRetentionBackup: Vytvoří databázi obnovením z trezoru dlouhodobého uchovávání. recoveryServicesRecoveryPointResourceId musí být zadané jako ID prostředku bodu obnovení.

Edice DataWarehouse nepodporují kopírování, sekundární a restoreLongTermRetentionBackup.

Name Typ Description
Copy

string

Default

string

OnlineSecondary

string

PointInTimeRestore

string

Recovery

string

Restore

string

RestoreExternalBackup

string

RestoreExternalBackupSecondary

string

RestoreLongTermRetentionBackup

string

Secondary

string

Database

Prostředek databáze.

Name Typ Description
id

string

ID prostředku.
identity

DatabaseIdentity

Identita Azure Active Directory databáze.
kind

string

Druh databáze. Toto jsou metadata používaná pro Azure Portal prostředí.
location

string

Umístění prostředku.
managedBy

string

Prostředek, který spravuje databázi.
name

string

Název prostředku.
properties.autoPauseDelay

integer

Čas v minutách, po kterém se databáze automaticky pozastaví. Hodnota -1 znamená, že automatické pozastavení je zakázané.
properties.catalogCollation

CatalogCollationType

Kolace katalogu metadat.
properties.collation

string

Kolace databáze.
properties.createMode

CreateMode

Určuje režim vytváření databáze.

Výchozí: pravidelné vytváření databáze.

Kopírování: Vytvoří databázi jako kopii existující databáze. sourceDatabaseId musí být zadáno jako ID prostředku zdrojové databáze.

Sekundární: Vytvoří databázi jako sekundární repliku existující databáze. sourceDatabaseId musí být zadáno jako ID prostředku existující primární databáze.

PointInTimeRestore: Vytvoří databázi obnovením zálohy existující databáze k určitému bodu v čase. sourceDatabaseId musí být zadáno jako ID prostředku existující databáze a musí být zadáno restorePointInTime.

Obnovení: Vytvoří databázi obnovením geograficky replikované zálohy. sourceDatabaseId musí být zadáno jako ID obnovitelného prostředku databáze, které chcete obnovit.

Obnovení: Vytvoří databázi obnovením zálohy odstraněné databáze. Musí být zadán sourceDatabaseId. Pokud sourceDatabaseId je ID původního prostředku databáze, musí být zadán sourceDatabaseDeletionDate. Jinak sourceDatabaseId musí být obnovitelné ID vyřazeného prostředku databáze a sourceDatabaseDeletionDate se ignoruje. restorePointInTime může být také zadán pro obnovení z dřívějšího bodu v čase.

RestoreLongTermRetentionBackup: Vytvoří databázi obnovením z trezoru dlouhodobého uchovávání. recoveryServicesRecoveryPointResourceId musí být zadané jako ID prostředku bodu obnovení.

Edice DataWarehouse nepodporují copy, secondary a RestoreLongTermRetentionBackup.
properties.creationDate

string

Datum vytvoření databáze (formát ISO8601).
properties.currentBackupStorageRedundancy

BackupStorageRedundancy

Typ účtu úložiště, který se používá k ukládání záloh pro tuto databázi.
properties.currentServiceObjectiveName

string

Aktuální název cíle na úrovni služby databáze.
properties.currentSku

Sku

Název a úroveň skladové položky.
properties.databaseId

string

ID databáze.
properties.defaultSecondaryLocation

string

Výchozí sekundární oblast pro tuto databázi.
properties.earliestRestoreDate

string

Zaznamenává nejstarší počáteční datum a čas, kdy je pro tuto databázi k dispozici obnovení (ISO8601 formát).
properties.elasticPoolId

string

Identifikátor prostředku elastického fondu obsahujícího tuto databázi.
properties.failoverGroupId

string

Identifikátor prostředku skupiny převzetí služeb při selhání, ke kterému tato databáze patří.
properties.federatedClientId

string

ID klienta použitého pro scénář klíče CMK mezi tenanty na databázi
properties.highAvailabilityReplicaCount

integer

Počet sekundárních replik přidružených k databázi, které se používají k zajištění vysoké dostupnosti. Nevztahuje se na databázi Hyperscale v rámci elastického fondu.
properties.isInfraEncryptionEnabled

boolean

Pro tuto databázi je povolené šifrování infrastruktury.
properties.isLedgerOn

boolean

Určuje, jestli je tato databáze databáze hlavní knihy, což znamená, že všechny tabulky v databázi jsou tabulky registru. Poznámka: Hodnotu této vlastnosti nelze po vytvoření databáze změnit.
properties.licenseType

DatabaseLicenseType

Typ licence, který se má použít pro tuto databázi. LicenseIncludedpokud potřebujete licenci nebo BasePrice pokud máte licenci a máte nárok na Zvýhodněné hybridní využití Azure.
properties.longTermRetentionBackupResourceId

string

Identifikátor prostředku dlouhodobého uchovávání záloh přidružených k operaci vytvoření této databáze.
properties.maintenanceConfigurationId

string

ID konfigurace údržby přiřazené k databázi. Tato konfigurace definuje období, kdy budou probíhat aktualizace údržby.
properties.maxLogSizeBytes

integer

Maximální velikost protokolu pro tuto databázi
properties.maxSizeBytes

integer

Maximální velikost databáze vyjádřená v bajtech.
properties.minCapacity

number

Minimální kapacita, kterou bude databáze mít vždy přidělenou, pokud není pozastavená
properties.pausedDate

string

Datum, kdy byla databáze pozastavena konfigurací nebo akcí uživatele (ISO8601 formát). Null, pokud je databáze připravená.
properties.readScale

DatabaseReadScale

Stav směrování jen pro čtení Pokud je povoleno, připojení, která mají v připojovací řetězec nastavený záměr aplikace na jen pro čtení, můžou být směrována na sekundární repliku jen pro čtení ve stejné oblasti. Nevztahuje se na databázi Hyperscale v rámci elastického fondu.
properties.recoverableDatabaseId

string

Identifikátor prostředku obnovitelné databáze přidružené k operaci vytvoření této databáze.
properties.recoveryServicesRecoveryPointId

string

Identifikátor prostředku bodu obnovení přidruženého k operaci vytvoření této databáze.
properties.requestedBackupStorageRedundancy

BackupStorageRedundancy

Typ účtu úložiště, který se má použít k ukládání záloh pro tuto databázi.
properties.requestedServiceObjectiveName

string

Požadovaný název cíle na úrovni služby databáze.
properties.restorableDroppedDatabaseId

string

Identifikátor prostředku obnovitelné vyřazené databáze přidružené k operaci vytvoření této databáze.
properties.restorePointInTime

string

Určuje bod v čase (ISO8601 formát) zdrojové databáze, která se obnoví za účelem vytvoření nové databáze.
properties.resumedDate

string

Datum obnovení databáze pomocí akce uživatele nebo přihlášení k databázi (ISO8601 formát). Null, pokud je databáze pozastavená.
properties.sampleName

SampleName

Název ukázkového schématu, které se má použít při vytváření této databáze.
properties.secondaryType

SecondaryType

Sekundární typ databáze, pokud se jedná o sekundární databázi. Platné hodnoty jsou Geo a Pojmenované.
properties.sourceDatabaseDeletionDate

string

Určuje čas odstranění databáze.
properties.sourceDatabaseId

string

Identifikátor prostředku zdrojové databáze přidružené k operaci vytvoření této databáze.
properties.sourceResourceId

string

Identifikátor prostředku zdroje přidruženého k operaci vytvoření této databáze.

Tato vlastnost je podporovaná pouze pro edici DataWarehouse a umožňuje obnovení napříč předplatnými.

Pokud je zadán sourceResourceId, nesmí být zadán sourceDatabaseId, recoverableDatabaseId, restoreableDroppedDatabaseId a sourceDatabaseDeletionDate a CreateMode musí být PointInTimeRestore, Restore nebo Recovery.

Pokud createMode je PointInTimeRestore, sourceResourceId musí být ID prostředku existující databáze nebo existujícího fondu SQL a musí být zadán restorePointInTime.

Pokud createMode je Obnovení, sourceResourceId musí být ID prostředku obnovitelné vyřazené databáze nebo obnovitelného vyřazeného fondu SQL.

Pokud createMode je Obnovit, sourceResourceId musí být ID prostředku obnovitelné databáze nebo obnovitelného fondu SQL.

Pokud zdrojové předplatné patří do jiného tenanta než cílového předplatného, musí hlavička x-ms-authorization-auxiliary obsahovat ověřovací token pro zdrojového tenanta. Další podrobnosti o hlavičce x-ms-authorization-auxiliary najdete v tématu https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
properties.status

DatabaseStatus

Stav databáze.
properties.zoneRedundant

boolean

Jestli je tato databáze zónově redundantní, což znamená, že repliky této databáze budou rozložené do několika zón dostupnosti.
sku

Sku

Skladová položka databáze.

Seznam skladových položek se může lišit podle oblasti a nabídky podpory. Pokud chcete určit skladové položky (včetně názvu skladové položky, úrovně/edice, řady a kapacity), které jsou dostupné pro vaše předplatné v oblasti Azure, použijte Capabilities_ListByLocation rozhraní REST API nebo jeden z následujících příkazů:

az sql db list-editions -l <location> -o table

Get-AzSqlServerServiceObjective -Location <location>
tags

object

Značky prostředků.
type

string

Typ prostředku.

DatabaseIdentity

Konfigurace identity Azure Active Directory pro prostředek

Name Typ Description
tenantId

string

ID tenanta Azure Active Directory
type

DatabaseIdentityType

Typ identity
userAssignedIdentities

<string,  DatabaseUserIdentity>

ID prostředků identit přiřazených uživatelem, které se mají použít

DatabaseIdentityType

Typ identity

Name Typ Description
None

string

UserAssigned

string

DatabaseLicenseType

Typ licence, která se má vztahovat na tuto databázi. LicenseIncludedpokud potřebujete licenci nebo BasePrice pokud máte licenci a máte nárok na Zvýhodněné hybridní využití Azure.

Name Typ Description
BasePrice

string

LicenseIncluded

string

DatabaseReadScale

Stav směrování jen pro čtení. Pokud je tato možnost povolená, připojení, která mají v připojovací řetězec záměr aplikace nastavený na jen pro čtení, se můžou směrovat na sekundární repliku jen pro čtení ve stejné oblasti. Nevztahuje se na databázi Hyperscale v rámci elastického fondu.

Name Typ Description
Disabled

string

Enabled

string

DatabaseStatus

Stav databáze.

Name Typ 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

Konfigurace identity Azure Active Directory pro prostředek

Name Typ Description
clientId

string

ID klienta Azure Active Directory.
principalId

string

ID objektu zabezpečení Azure Active Directory.

SampleName

Název ukázkového schématu, které se má použít při vytváření této databáze.

Name Typ Description
AdventureWorksLT

string

WideWorldImportersFull

string

WideWorldImportersStd

string

SecondaryType

Sekundární typ databáze, pokud se jedná o sekundární databázi. Platné hodnoty jsou Geo (Geografická oblast) a Named (Pojmenované).

Name Typ Description
Geo

string

Named

string

Sku

Skladová položka prostředku ARM.

Name Typ Description
capacity

integer

Kapacita konkrétní skladové položky.
family

string

Pokud má služba různé generace hardwaru, pro stejnou skladovou položku, můžete to tady zaznamenat.
name

string

Název skladové položky, obvykle písmeno + číselný kód, např. P3.
size

string

Velikost konkrétní skladové položky
tier

string

Úroveň nebo edice konkrétní skladové položky, například Basic, Premium.