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á obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo 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	Byla úspěšně načtena zadaná databáze.
Other Status Codes		Chybové odpovědi: *** 404 SubscriptionDoesNotHaveServer – Požadovaný server nebyl nalezen. 404 ServerNotInSubscriptionResourceGroup – Zadaný server neexistuje v zadané skupině prostředků a předplatném. 404 ResourceNotFound – Požadovaný prostředek nebyl nalezen.

Name

Typ

Description

200 OK

Database

Byla úspěšně načtena zadaná databáze.

Other Status Codes

Chybové odpovědi: ***

404 SubscriptionDoesNotHaveServer – Požadovaný server nebyl nalezen.
404 ServerNotInSubscriptionResourceGroup – Zadaný server neexistuje v zadané skupině prostředků a předplatném.
404 ResourceNotFound – Požadovaný prostředek nebyl nalezen.

Příklady

Gets a database.

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


/**
 * Samples for Databases Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/GetVCoreDatabase.json
     */
    /**
     * Sample code: Gets a database.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsADatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabases().getWithResponse("Default-SQL-SouthEastAsia",
            "testsvr", "testdb", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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ě použitý 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í hodnota: běžné vytvoření databáze. Kopírování: Vytvoří databázi jako kopii existující databáze. sourceDatabaseId musí být zadán 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án 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án jako ID prostředku existující databáze a restorePointInTime musí být zadán. Obnovení: Vytvoří databázi obnovením geograficky replikované zálohy. sourceDatabaseId musí být zadán jako obnovitelné ID prostředku databáze. Obnovení: Vytvoří databázi obnovením zálohy odstraněné databáze. sourceDatabaseId musí být zadán. Pokud je sourceDatabaseId původní ID prostředku databáze, musí být zadán sourceDatabaseDeletionDate. Jinak sourceDatabaseId musí být obnovitelné vyřazené ID 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 dlouhodobého trezoru uchovávání. recoveryServicesRecoveryPointResourceId musí být zadán jako ID prostředku bodu obnovení. Edice DataWarehouse nepodporuje kopírování, sekundární a restoreLongTermRetentionBackup.
Database	Databázový prostředek.
DatabaseIdentity	Konfigurace identity Azure Active Directory pro prostředek
DatabaseIdentityType	Typ identity
DatabaseLicenseType	Typ licence, který se má použít pro tuto databázi. `LicenseIncluded`, pokud 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á, mohou být připojení, která mají v připojovacím řetězci nastavený záměr aplikace nastavenou na čtení, směrována do sekundární repliky jen pro čtení ve stejné oblasti. Neplatí pro 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 je sekundární. Platné hodnoty jsou geo a pojmenované.
Sku	Skladová položka prostředku ARM.

BackupStorageRedundancy

Výčet

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

Hodnota	Description
Geo
GeoZone
Local
Zone

CatalogCollationType

Výčet

Kolace katalogu metadat.

Hodnota	Description
DATABASE_DEFAULT
SQL_Latin1_General_CP1_CI_AS

CreateMode

Výčet

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

Výchozí hodnota: běžné vytvoření databáze.

Kopírování: Vytvoří databázi jako kopii existující databáze. sourceDatabaseId musí být zadán 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án 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án jako ID prostředku existující databáze a restorePointInTime musí být zadán.

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

Obnovení: Vytvoří databázi obnovením zálohy odstraněné databáze. sourceDatabaseId musí být zadán. Pokud je sourceDatabaseId původní ID prostředku databáze, musí být zadán sourceDatabaseDeletionDate. Jinak sourceDatabaseId musí být obnovitelné vyřazené ID 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 dlouhodobého trezoru uchovávání. recoveryServicesRecoveryPointResourceId musí být zadán jako ID prostředku bodu obnovení.

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

Hodnota	Description
Copy
Default
OnlineSecondary
PointInTimeRestore
Recovery
Restore
RestoreExternalBackup
RestoreExternalBackupSecondary
RestoreLongTermRetentionBackup
Secondary

Database

Objekt

Databázový prostředek.

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 prostředí webu Azure Portal.
location	string	Umístění prostředku
managedBy	string	Prostředek, který spravuje databázi.
name	string	Název prostředku
properties.autoPauseDelay	integer (int32)	Doba v minutách, po které 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í hodnota: běžné vytvoření databáze. Kopírování: Vytvoří databázi jako kopii existující databáze. sourceDatabaseId musí být zadán 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án 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án jako ID prostředku existující databáze a restorePointInTime musí být zadán. Obnovení: Vytvoří databázi obnovením geograficky replikované zálohy. sourceDatabaseId musí být zadán jako obnovitelné ID prostředku databáze. Obnovení: Vytvoří databázi obnovením zálohy odstraněné databáze. sourceDatabaseId musí být zadán. Pokud je sourceDatabaseId původní ID prostředku databáze, musí být zadán sourceDatabaseDeletionDate. Jinak sourceDatabaseId musí být obnovitelné vyřazené ID 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 dlouhodobého trezoru uchovávání. recoveryServicesRecoveryPointResourceId musí být zadán jako ID prostředku bodu obnovení. Edice DataWarehouse nepodporuje kopírování, sekundární a restoreLongTermRetentionBackup.
properties.creationDate	string (date-time)	Datum vytvoření databáze (formát ISO8601).
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Typ účtu úložiště použitý 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 (uuid)	ID databáze.
properties.defaultSecondaryLocation	string	Výchozí sekundární oblast pro tuto databázi.
properties.earliestRestoreDate	string (date-time)	Zaznamenává nejstarší počáteční datum a čas, kdy je pro tuto databázi k dispozici obnovení (ISO8601 formát).
properties.elasticPoolId	string (arm-id)	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í, do kterého tato databáze patří.
properties.federatedClientId	string (uuid)	ID klienta používaného pro scénář cmk pro různé tenanty na databázi
properties.highAvailabilityReplicaCount	integer (int32)	Počet sekundárních replik přidružených k databázi, která slouží k zajištění vysoké dostupnosti. Neplatí pro databázi Hyperscale v rámci elastického fondu.
properties.isInfraEncryptionEnabled	boolean	Pro tuto databázi je povolené šifrování infrastruktury.
properties.isLedgerOn	boolean	Bez ohledu na to, jestli se jedná o databázi registru, znamená to, ž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. `LicenseIncluded`, pokud 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 (arm-id)	Identifikátor prostředku dlouhodobého uchovávání záloh přidružených k vytvoření operace této databáze.
properties.maintenanceConfigurationId	string	ID konfigurace údržby přiřazené k databázi. Tato konfigurace definuje období, kdy dojde k aktualizacím údržby.
properties.maxLogSizeBytes	integer (int64)	Maximální velikost protokolu pro tuto databázi.
properties.maxSizeBytes	integer (int64)	Maximální velikost databáze vyjádřená v bajtech.
properties.minCapacity	number (double)	Minimální kapacita, kterou databáze bude mít vždy přidělenou, pokud není pozastavená
properties.pausedDate	string (date-time)	Datum, kdy byla databáze pozastavena konfigurací nebo akcí uživatele (ISO8601 formát). Hodnota Null, pokud je databáze připravená.
properties.readScale	DatabaseReadScale	Stav směrování jen pro čtení. Pokud je tato možnost povolená, mohou být připojení, která mají v připojovacím řetězci nastavený záměr aplikace nastavenou na čtení, směrována do sekundární repliky jen pro čtení ve stejné oblasti. Neplatí pro databázi Hyperscale v rámci elastického fondu.
properties.recoverableDatabaseId	string (arm-id)	Identifikátor prostředku obnovitelné databáze přidružené k operaci vytvoření této databáze.
properties.recoveryServicesRecoveryPointId	string (arm-id)	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 (arm-id)	Identifikátor prostředku obnovené vyřazené databáze přidružené k operaci vytvoření této databáze.
properties.restorePointInTime	string (date-time)	Určuje bod v čase (formát ISO8601) zdrojové databáze, která se obnoví a vytvoří novou databázi.
properties.resumedDate	string (date-time)	Datum, kdy byla databáze obnovena akcí uživatele nebo přihlášením k databázi (ISO8601 formát). Hodnota Null, pokud je databáze pozastavena.
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 je sekundární. Platné hodnoty jsou geo a pojmenované.
properties.sourceDatabaseDeletionDate	string (date-time)	Určuje čas odstranění databáze.
properties.sourceDatabaseId	string (arm-id)	Identifikátor prostředku zdrojové databáze přidružené k operaci vytvoření této databáze.
properties.sourceResourceId	string (arm-id)	Identifikátor prostředku zdroje přidruženého k operaci vytvoření této databáze. Tato vlastnost je podporována pouze pro edici DataWarehouse a umožňuje obnovení napříč předplatnými. Pokud je zadán sourceResourceId, sourceDatabaseId, recoverableDatabaseId, restoreableDroppedDatabaseId a sourceDatabaseDeletionDate nesmí být zadán a CreateMode musí být PointInTimeRestore, Restore nebo Recover. Pokud je createMode PointInTimeRestore, sourceResourceId musí být ID prostředku existující databáze nebo existujícího fondu SQL a restorePointInTime musí být zadán. Pokud je createMode Restore, sourceResourceId musí být ID prostředku obnovitelné vyřazené databáze nebo obnovitelné vyřazené fondu SQL. Pokud je createMode Recover, 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	Bez ohledu na to, jestli je tato databáze zónově redundantní, což znamená, že repliky této databáze budou rozloženy do více 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, rodiny 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 zdroje.

DatabaseIdentity

Objekt

Konfigurace identity Azure Active Directory pro prostředek

Name	Typ	Description
tenantId	string (uuid)	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

Výčet

Typ identity

Hodnota	Description
None
UserAssigned

DatabaseLicenseType

Výčet

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

Hodnota	Description
BasePrice
LicenseIncluded

DatabaseReadScale

Výčet

Stav směrování jen pro čtení. Pokud je tato možnost povolená, mohou být připojení, která mají v připojovacím řetězci nastavený záměr aplikace nastavenou na čtení, směrována do sekundární repliky jen pro čtení ve stejné oblasti. Neplatí pro databázi Hyperscale v rámci elastického fondu.

Hodnota	Description
Disabled
Enabled

DatabaseStatus

Výčet

Stav databáze.

Hodnota	Description
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

Objekt

Konfigurace identity Azure Active Directory pro prostředek

Name	Typ	Description
clientId	string (uuid)	ID klienta Azure Active Directory.
principalId	string (uuid)	ID objektu zabezpečení Azure Active Directory.

SampleName

Výčet

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

Hodnota	Description
AdventureWorksLT
WideWorldImportersFull
WideWorldImportersStd

SecondaryType

Výčet

Sekundární typ databáze, pokud je sekundární. Platné hodnoty jsou geo a pojmenované.

Hodnota	Description
Geo
Named

Sku

Objekt

Skladová položka prostředku ARM.

Name	Typ	Description
capacity	integer (int32)	Kapacita konkrétní skladové položky.
family	string	Pokud má služba různé generace hardwaru, pro stejnou skladovou položku, můžete ji zde zachytit.
name	string	Název skladové položky, obvykle písmeno + číslo, např. P3.
size	string	Velikost konkrétní skladové položky
tier	string	Úroveň nebo edice konkrétní skladové položky, např. Basic, Premium.

Sdílet prostřednictvím

Databases - Get

Parametry identifikátoru URI

Odpovědi

Příklady

Gets a database.

Ukázkový požadavek

Ukázková odpověď

Definice

BackupStorageRedundancy

CatalogCollationType

CreateMode

Database

DatabaseIdentity

DatabaseIdentityType

DatabaseLicenseType

DatabaseReadScale

DatabaseStatus

DatabaseUserIdentity

SampleName

SecondaryType

Sku

Další materiály