Databases - Get

Odwołanie

Usługa:: SQL Database

Wersja interfejsu API:: 2021-11-01

Pobiera bazę danych.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
databaseName	path	True	string	Nazwa bazy danych.
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API Resource Manager platformy Azure lub portalu.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Database	Pomyślnie pobrano określoną bazę danych.
Other Status Codes		Odpowiedzi na błędy: *** 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera 404 ServerNotInSubscriptionResourceGroup — określony serwer nie istnieje w określonej grupie zasobów i subskrypcji. 404 ResourceNotFound — żądany zasób nie został znaleziony.

Nazwa

Typ

Opis

200 OK

Database

Pomyślnie pobrano określoną bazę danych.

Other Status Codes

Odpowiedzi na błędy: ***

404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera
404 ServerNotInSubscriptionResourceGroup — określony serwer nie istnieje w określonej grupie zasobów i subskrypcji.
404 ResourceNotFound — żądany zasób nie został znaleziony.

Przykłady

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
BackupStorageRedundancy	Typ konta magazynu używany do przechowywania kopii zapasowych dla tej bazy danych.
CatalogCollationType	Sortowanie wykazu metadanych.
CreateMode	Określa tryb tworzenia bazy danych. Ustawienie domyślne: regularne tworzenie bazy danych. Kopiowanie: tworzy bazę danych jako kopię istniejącej bazy danych. sourceDatabaseId musi być określony jako identyfikator zasobu źródłowej bazy danych. Pomocnicza: tworzy bazę danych jako pomocniczą replikę istniejącej bazy danych. sourceDatabaseId musi być określony jako identyfikator zasobu istniejącej podstawowej bazy danych. PointInTimeRestore: tworzy bazę danych przez przywrócenie kopii zapasowej istniejącej bazy danych w czasie. sourceDatabaseId musi być określony jako identyfikator zasobu istniejącej bazy danych, a należy określić wartość restorePointInTime. Odzyskiwanie: tworzy bazę danych przez przywrócenie kopii zapasowej replikowanej geograficznie. sourceDatabaseId należy określić jako identyfikator zasobu bazy danych, który można odzyskać, aby przywrócić. Przywracanie: tworzy bazę danych przez przywrócenie kopii zapasowej usuniętej bazy danych. parametr sourceDatabaseId musi być określony. Jeśli parametr sourceDatabaseId jest oryginalnym identyfikatorem zasobu bazy danych, należy określić parametr sourceDatabaseDeletionDate. W przeciwnym razie parametr sourceDatabaseId musi być identyfikatorem zasobu bazy danych, a element sourceDatabaseDeletionDate jest ignorowany. restorePointInTime można również określić, aby przywrócić z wcześniejszego punktu w czasie. RestoreLongTermRetentionBackup: tworzy bazę danych przez przywrócenie z magazynu długoterminowego przechowywania. recoveryServicesRecoveryPointResourceId musi być określony jako identyfikator zasobu punktu odzyskiwania. Funkcja Copy, Secondary i RestoreLongTermRetentionBackup nie jest obsługiwana w przypadku wersji DataWarehouse.
Database	Zasób bazy danych.
DatabaseIdentity	Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.
DatabaseIdentityType	Typ tożsamości
DatabaseLicenseType	Typ licencji do zastosowania dla tej bazy danych. `LicenseIncluded`jeśli potrzebujesz licencji lub `BasePrice` masz licencję i kwalifikujesz się do Korzyść użycia hybrydowego platformy Azure.
DatabaseReadScale	Stan routingu tylko do odczytu. W przypadku włączenia połączeń z intencją aplikacji ustawionych na odczyt w parametry połączenia mogą być kierowane do repliki pomocniczej odczytu w tym samym regionie. Nie dotyczy bazy danych hiperskala w puli elastycznej.
DatabaseStatus	Stan bazy danych.
DatabaseUserIdentity	Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.
SampleName	Nazwa przykładowego schematu do zastosowania podczas tworzenia tej bazy danych.
SecondaryType	Pomocniczy typ bazy danych, jeśli jest pomocniczy. Prawidłowe wartości to Geo i Nazwane.
Sku	Jednostka SKU zasobu usługi ARM.

BackupStorageRedundancy

Typ konta magazynu używany do przechowywania kopii zapasowych dla tej bazy danych.

Nazwa	Typ	Opis
Geo	string
GeoZone	string
Local	string
Zone	string

CatalogCollationType

Sortowanie wykazu metadanych.

Nazwa	Typ	Opis
DATABASE_DEFAULT	string
SQL_Latin1_General_CP1_CI_AS	string

CreateMode

Określa tryb tworzenia bazy danych.

Ustawienie domyślne: regularne tworzenie bazy danych.

Kopiowanie: tworzy bazę danych jako kopię istniejącej bazy danych. sourceDatabaseId musi być określony jako identyfikator zasobu źródłowej bazy danych.

Pomocnicza: tworzy bazę danych jako pomocniczą replikę istniejącej bazy danych. sourceDatabaseId musi być określony jako identyfikator zasobu istniejącej podstawowej bazy danych.

PointInTimeRestore: tworzy bazę danych przez przywrócenie kopii zapasowej istniejącej bazy danych w czasie. sourceDatabaseId musi być określony jako identyfikator zasobu istniejącej bazy danych, a należy określić wartość restorePointInTime.

Odzyskiwanie: tworzy bazę danych przez przywrócenie kopii zapasowej replikowanej geograficznie. sourceDatabaseId należy określić jako identyfikator zasobu bazy danych, który można odzyskać, aby przywrócić.

Przywracanie: tworzy bazę danych przez przywrócenie kopii zapasowej usuniętej bazy danych. parametr sourceDatabaseId musi być określony. Jeśli parametr sourceDatabaseId jest oryginalnym identyfikatorem zasobu bazy danych, należy określić parametr sourceDatabaseDeletionDate. W przeciwnym razie parametr sourceDatabaseId musi być identyfikatorem zasobu bazy danych, a element sourceDatabaseDeletionDate jest ignorowany. restorePointInTime można również określić, aby przywrócić z wcześniejszego punktu w czasie.

RestoreLongTermRetentionBackup: tworzy bazę danych przez przywrócenie z magazynu długoterminowego przechowywania. recoveryServicesRecoveryPointResourceId musi być określony jako identyfikator zasobu punktu odzyskiwania.

Funkcja Copy, Secondary i RestoreLongTermRetentionBackup nie jest obsługiwana w przypadku wersji DataWarehouse.

Nazwa	Typ	Opis
Copy	string
Default	string
OnlineSecondary	string
PointInTimeRestore	string
Recovery	string
Restore	string
RestoreExternalBackup	string
RestoreExternalBackupSecondary	string
RestoreLongTermRetentionBackup	string
Secondary	string

Database

Zasób bazy danych.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
identity	DatabaseIdentity	Tożsamość usługi Azure Active Directory bazy danych.
kind	string	Rodzaj bazy danych. Są to metadane używane w środowisku Azure Portal.
location	string	Lokalizacja zasobu.
managedBy	string	Zasób, który zarządza bazą danych.
name	string	Nazwa zasobu.
properties.autoPauseDelay	integer	Czas w minutach, po którym baza danych jest automatycznie wstrzymana. Wartość -1 oznacza, że automatyczne wstrzymanie jest wyłączone
properties.catalogCollation	CatalogCollationType	Sortowanie wykazu metadanych.
properties.collation	string	Sortowanie bazy danych.
properties.createMode	CreateMode	Określa tryb tworzenia bazy danych. Ustawienie domyślne: regularne tworzenie bazy danych. Kopiowanie: tworzy bazę danych jako kopię istniejącej bazy danych. sourceDatabaseId musi być określony jako identyfikator zasobu źródłowej bazy danych. Pomocnicza: tworzy bazę danych jako replikę pomocniczą istniejącej bazy danych. sourceDatabaseId musi być określony jako identyfikator zasobu istniejącej podstawowej bazy danych. PointInTimeRestore: tworzy bazę danych przez przywrócenie kopii zapasowej istniejącej bazy danych do punktu w czasie. sourceDatabaseId musi być określony jako identyfikator zasobu istniejącej bazy danych, a parametr restorePointInTime musi być określony. Odzyskiwanie: tworzy bazę danych przez przywrócenie kopii zapasowej replikowanej geograficznie. sourceDatabaseId musi być określony jako identyfikator zasobu bazy danych, który można odzyskać, aby przywrócić. Przywracanie: tworzy bazę danych przez przywrócenie kopii zapasowej usuniętej bazy danych. parametr sourceDatabaseId musi być określony. Jeśli parametr sourceDatabaseId jest oryginalnym identyfikatorem zasobu bazy danych, należy określić parametr sourceDatabaseDeletionDate. W przeciwnym razie parametr sourceDatabaseId musi być identyfikatorem usuniętego zasobu bazy danych, a właściwość sourceDatabaseDeletionDate jest ignorowana. Można również określić element restorePointInTime w celu przywrócenia z wcześniejszego punktu w czasie. RestoreLongTermRetentionBackup: tworzy bazę danych przez przywrócenie z magazynu długoterminowego przechowywania. recoveryServicesRecoveryPointResourceId musi być określony jako identyfikator zasobu punktu odzyskiwania. Funkcja Copy, Secondary i RestoreLongTermRetentionBackup nie jest obsługiwana w przypadku wersji DataWarehouse.
properties.creationDate	string	Data utworzenia bazy danych (format ISO8601).
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Typ konta magazynu używany do przechowywania kopii zapasowych dla tej bazy danych.
properties.currentServiceObjectiveName	string	Bieżąca nazwa celu poziomu usługi bazy danych.
properties.currentSku	Sku	Nazwa i warstwa jednostki SKU.
properties.databaseId	string	Identyfikator bazy danych.
properties.defaultSecondaryLocation	string	Domyślny region pomocniczy dla tej bazy danych.
properties.earliestRestoreDate	string	Rejestruje najwcześniejszą datę i godzinę rozpoczęcia przywracania dla tej bazy danych (format ISO8601).
properties.elasticPoolId	string	Identyfikator zasobu elastycznej puli zawierającej tę bazę danych.
properties.failoverGroupId	string	Identyfikator zasobu grupy trybu failover, do którego należy ta baza danych.
properties.federatedClientId	string	Identyfikator klienta używany w scenariuszu cmK dla wielu dzierżaw na bazę danych
properties.highAvailabilityReplicaCount	integer	Liczba replik pomocniczych skojarzonych z bazą danych, która jest używana do zapewnienia wysokiej dostępności. Nie dotyczy bazy danych w warstwie Hiperskala w elastycznej puli.
properties.isInfraEncryptionEnabled	boolean	Szyfrowanie infra jest włączone dla tej bazy danych.
properties.isLedgerOn	boolean	Niezależnie od tego, czy ta baza danych jest bazą danych rejestru, co oznacza, że wszystkie tabele w bazie danych są tabelami rejestru. Uwaga: nie można zmienić wartości tej właściwości po utworzeniu bazy danych.
properties.licenseType	DatabaseLicenseType	Typ licencji do zastosowania dla tej bazy danych. `LicenseIncluded`jeśli potrzebujesz licencji lub `BasePrice` masz licencję i kwalifikujesz się do Korzyść użycia hybrydowego platformy Azure.
properties.longTermRetentionBackupResourceId	string	Identyfikator zasobu kopii zapasowej długoterminowego przechowywania skojarzony z operacją tworzenia tej bazy danych.
properties.maintenanceConfigurationId	string	Identyfikator konfiguracji konserwacji przypisany do bazy danych. Ta konfiguracja określa okres, w których będą wykonywane aktualizacje konserwacji.
properties.maxLogSizeBytes	integer	Maksymalny rozmiar dziennika dla tej bazy danych.
properties.maxSizeBytes	integer	Maksymalny rozmiar bazy danych wyrażony w bajtach.
properties.minCapacity	number	Minimalna pojemność, którą baza danych będzie zawsze przydzielana, jeśli nie została wstrzymana
properties.pausedDate	string	Data wstrzymania bazy danych przez konfigurację użytkownika lub akcję (format ISO8601). Wartość null, jeśli baza danych jest gotowa.
properties.readScale	DatabaseReadScale	Stan routingu tylko do odczytu. Jeśli ta opcja jest włączona, połączenia, które mają intencję aplikacji ustawioną na odczyt w parametry połączenia, mogą być kierowane do repliki pomocniczej tylko do odczytu w tym samym regionie. Nie dotyczy bazy danych w warstwie Hiperskala w elastycznej puli.
properties.recoverableDatabaseId	string	Identyfikator zasobu możliwej do odzyskania bazy danych skojarzony z operacją tworzenia tej bazy danych.
properties.recoveryServicesRecoveryPointId	string	Identyfikator zasobu punktu odzyskiwania skojarzonego z operacją tworzenia tej bazy danych.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Typ konta magazynu, który ma być używany do przechowywania kopii zapasowych dla tej bazy danych.
properties.requestedServiceObjectiveName	string	Żądana nazwa celu poziomu usługi bazy danych.
properties.restorableDroppedDatabaseId	string	Identyfikator zasobu usuniętej bazy danych skojarzonej z operacją tworzenia tej bazy danych.
properties.restorePointInTime	string	Określa punkt w czasie (format ISO8601) źródłowej bazy danych, która zostanie przywrócona w celu utworzenia nowej bazy danych.
properties.resumedDate	string	Data wznowienia bazy danych przez akcję użytkownika lub identyfikator logowania bazy danych (ISO8601 format). Wartość null, jeśli baza danych jest wstrzymana.
properties.sampleName	SampleName	Nazwa przykładowego schematu, który ma być stosowany podczas tworzenia tej bazy danych.
properties.secondaryType	SecondaryType	Pomocniczy typ bazy danych, jeśli jest pomocniczy. Prawidłowe wartości to Geo i Named.
properties.sourceDatabaseDeletionDate	string	Określa czas usunięcia bazy danych.
properties.sourceDatabaseId	string	Identyfikator zasobu źródłowej bazy danych skojarzonej z operacją tworzenia tej bazy danych.
properties.sourceResourceId	string	Identyfikator zasobu źródła skojarzonego z operacją tworzenia tej bazy danych. Ta właściwość jest obsługiwana tylko w przypadku wersji DataWarehouse i umożliwia przywracanie między subskrypcjami. Jeśli określono parametr sourceResourceId, sourceDatabaseId, recoverableDatabaseId, restoreableDroppedDatabaseId i sourceDatabaseDeletionDate nie może być określony, a parametr CreateMode musi mieć wartość PointInTimeRestore, Restore lub Recover. Jeśli parametr createMode to PointInTimeRestore, parametr sourceResourceId musi być identyfikatorem zasobu istniejącej bazy danych lub istniejącej puli SQL, a parametr restorePointInTime musi być określony. Gdy parametr createMode to Restore, sourceResourceId musi być identyfikatorem zasobu przywracalnej usuniętej bazy danych lub można przywrócić porzuconą pulę SQL. W przypadku odzyskiwania parametru createMode identyfikator sourceResourceId musi być identyfikatorem zasobu możliwej do odzyskania bazy danych lub możliwej do odzyskania puli SQL. Gdy subskrypcja źródłowa należy do innej dzierżawy niż subskrypcja docelowa, nagłówek "x-ms-authorization-auxiliary" musi zawierać token uwierzytelniania dla dzierżawy źródłowej. Aby uzyskać więcej informacji na temat nagłówka "x-ms-authorization-auxiliary", zobacz https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
properties.status	DatabaseStatus	Stan bazy danych.
properties.zoneRedundant	boolean	Niezależnie od tego, czy ta baza danych jest strefowo nadmiarowa, co oznacza, że repliki tej bazy danych będą rozłożone na wiele stref dostępności.
sku	Sku	Jednostka SKU bazy danych. Lista jednostek SKU może się różnić w zależności od regionu i oferty pomocy technicznej. Aby określić jednostki SKU (w tym nazwę jednostki SKU, warstwę/wydanie, rodzinę i pojemność), które są dostępne dla twojej subskrypcji w regionie świadczenia usługi Azure, użyj interfejsu `Capabilities_ListByLocation` API REST lub jednego z następujących poleceń: `az sql db list-editions -l <location> -o table` `Get-AzSqlServerServiceObjective -Location <location>`
tags	object	Tagi zasobów.
type	string	Typ zasobu.

DatabaseIdentity

Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.

Nazwa	Typ	Opis
tenantId	string	Identyfikator dzierżawy usługi Azure Active Directory.
type	DatabaseIdentityType	Typ tożsamości
userAssignedIdentities	<string, DatabaseUserIdentity>	Identyfikatory zasobów tożsamości przypisanych przez użytkownika do użycia

DatabaseIdentityType

Typ tożsamości

Nazwa	Typ	Opis
None	string
UserAssigned	string

DatabaseLicenseType

Typ licencji do zastosowania dla tej bazy danych. LicenseIncludedjeśli potrzebujesz licencji lub BasePrice masz licencję i kwalifikujesz się do Korzyść użycia hybrydowego platformy Azure.

Nazwa	Typ	Opis
BasePrice	string
LicenseIncluded	string

DatabaseReadScale

Stan routingu tylko do odczytu. W przypadku włączenia połączeń z intencją aplikacji ustawionych na odczyt w parametry połączenia mogą być kierowane do repliki pomocniczej odczytu w tym samym regionie. Nie dotyczy bazy danych hiperskala w puli elastycznej.

Nazwa	Typ	Opis
Disabled	string
Enabled	string

DatabaseStatus

Stan bazy danych.

Nazwa	Typ	Opis
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

Konfiguracja tożsamości usługi Azure Active Directory dla zasobu.

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta usługi Azure Active Directory.
principalId	string	Identyfikator podmiotu zabezpieczeń usługi Azure Active Directory.

SampleName

Nazwa przykładowego schematu do zastosowania podczas tworzenia tej bazy danych.

Nazwa	Typ	Opis
AdventureWorksLT	string
WideWorldImportersFull	string
WideWorldImportersStd	string

SecondaryType

Pomocniczy typ bazy danych, jeśli jest pomocniczy. Prawidłowe wartości to Geo i Nazwane.

Nazwa	Typ	Opis
Geo	string
Named	string

Sku

Jednostka SKU zasobu usługi ARM.

Nazwa	Typ	Opis
capacity	integer	Pojemność konkretnej jednostki SKU.
family	string	Jeśli usługa ma różne generacje sprzętu, dla tej samej jednostki SKU, można je przechwycić tutaj.
name	string	Nazwa jednostki SKU, zazwyczaj, litera + kod numeryczny, np. P3.
size	string	Rozmiar konkretnej jednostki SKU
tier	string	Warstwa lub wersja konkretnej jednostki SKU, np. Podstawowa, Premium.

Udostępnij za pośrednictwem

Databases - Get

Parametry identyfikatora URI

Odpowiedzi

Przykłady

Gets a database.

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

BackupStorageRedundancy

CatalogCollationType

CreateMode

Database

DatabaseIdentity

DatabaseIdentityType

DatabaseLicenseType

DatabaseReadScale

DatabaseStatus

DatabaseUserIdentity

SampleName

SecondaryType

Sku

Dodatkowe zasoby