Databases - Get

Служба:: SQL Database

Версия API:: 2025-01-01

Получает базу данных.

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

С использованием необязательных параметров:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}?api-version=2025-01-01&$expand={$expand}&$filter={$filter}

Параметры URI

Имя	В	Обязательно	Тип	Описание
databaseName	path	True	string	Имя базы данных.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
serverName	path	True	string	Имени сервера.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
$expand	query		string	Дочерние ресурсы для включения в ответ.
$filter	query		string	Выражение фильтра OData, которое фильтрует элементы в коллекции.

Ответы

Имя	Тип	Описание
200 OK	Database	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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 using versionless keys.

Gets a database with database level keys expanded.

Gets a database.

Gets a database configured with Default enclave type.

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

{
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "kind": "v12.0,user,vcore",
  "location": "southeastasia",
  "properties": {
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentBackupStorageRedundancy": "Geo",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "currentSku": {
      "name": "BC_Gen5",
      "capacity": 2,
      "tier": "BusinessCritical"
    },
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "defaultSecondaryLocation": "North Europe",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "isInfraEncryptionEnabled": false,
    "isLedgerOn": false,
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "maxLogSizeBytes": 104857600,
    "maxSizeBytes": 268435456000,
    "preferredEnclaveType": "Default",
    "readScale": "Enabled",
    "requestedBackupStorageRedundancy": "Geo",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "status": "Online",
    "zoneRedundant": false
  },
  "sku": {
    "name": "BC_Gen5",
    "capacity": 2,
    "tier": "BusinessCritical"
  }
}

Gets a database configured with VBS enclave type.

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

{
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "kind": "v12.0,user,vcore",
  "location": "southeastasia",
  "properties": {
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentBackupStorageRedundancy": "Geo",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "currentSku": {
      "name": "BC_Gen5",
      "capacity": 2,
      "tier": "BusinessCritical"
    },
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "defaultSecondaryLocation": "North Europe",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "isInfraEncryptionEnabled": false,
    "isLedgerOn": false,
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "maxLogSizeBytes": 104857600,
    "maxSizeBytes": 268435456000,
    "preferredEnclaveType": "VBS",
    "readScale": "Enabled",
    "requestedBackupStorageRedundancy": "Geo",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "status": "Online",
    "zoneRedundant": false
  },
  "sku": {
    "name": "BC_Gen5",
    "capacity": 2,
    "tier": "BusinessCritical"
  }
}

Gets a database with Availability zone specified.

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

{
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "kind": "v12.0,user",
  "location": "southeastasia",
  "properties": {
    "availabilityZone": "1",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentBackupStorageRedundancy": "Geo",
    "currentServiceObjectiveName": "S0",
    "currentSku": {
      "name": "Standard",
      "capacity": 10,
      "tier": "Standard"
    },
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "defaultSecondaryLocation": "North Europe",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "isInfraEncryptionEnabled": false,
    "isLedgerOn": false,
    "maxSizeBytes": 1073741824,
    "readScale": "Disabled",
    "requestedBackupStorageRedundancy": "Geo",
    "requestedServiceObjectiveName": "S0",
    "status": "Online",
    "zoneRedundant": false
  },
  "sku": {
    "name": "S0",
    "capacity": 10,
    "tier": "Standard"
  }
}

Gets a database with database level keys expanded using versionless keys.

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2025-01-01&$expand=keys

Пример ответа

Код состояния:: 200

{
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "kind": "v12.0,user,vcore",
  "location": "southeastasia",
  "properties": {
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentBackupStorageRedundancy": "Geo",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "currentSku": {
      "name": "BC_Gen5",
      "capacity": 2,
      "tier": "BusinessCritical"
    },
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "defaultSecondaryLocation": "North Europe",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "encryptionProtector": "https://your-key-vault-name.vault.azure.net/yourKey",
    "isInfraEncryptionEnabled": false,
    "isLedgerOn": false,
    "keys": {
      "https://your-key-vault-name.vault.azure.net/yourKey": {},
      "https://your-key-vault-name.vault.azure.net/yourKey2": {}
    },
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "maxLogSizeBytes": 104857600,
    "maxSizeBytes": 268435456000,
    "readScale": "Enabled",
    "requestedBackupStorageRedundancy": "Geo",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "status": "Online",
    "zoneRedundant": false
  },
  "sku": {
    "name": "BC_Gen5",
    "capacity": 2,
    "tier": "BusinessCritical"
  }
}

Gets a database with database level keys expanded.

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2025-01-01&$expand=keys

Пример ответа

Код состояния:: 200

{
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "kind": "v12.0,user,vcore",
  "location": "southeastasia",
  "properties": {
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentBackupStorageRedundancy": "Geo",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "currentSku": {
      "name": "BC_Gen5",
      "capacity": 2,
      "tier": "BusinessCritical"
    },
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "defaultSecondaryLocation": "North Europe",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "encryptionProtector": "https://your-key-vault-name.vault.azure.net/yourKey/yourKeyVersion",
    "isInfraEncryptionEnabled": false,
    "isLedgerOn": false,
    "keys": {
      "https://your-key-vault-name.vault.azure.net/yourKey/yourKeyVersion": {},
      "https://your-key-vault-name.vault.azure.net/yourKey2/yourKey2Version": {}
    },
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "maxLogSizeBytes": 104857600,
    "maxSizeBytes": 268435456000,
    "readScale": "Enabled",
    "requestedBackupStorageRedundancy": "Geo",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "status": "Online",
    "zoneRedundant": false
  },
  "sku": {
    "name": "BC_Gen5",
    "capacity": 2,
    "tier": "BusinessCritical"
  }
}

Gets a database.

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

{
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "kind": "v12.0,user,vcore",
  "location": "southeastasia",
  "properties": {
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentBackupStorageRedundancy": "Geo",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "currentSku": {
      "name": "BC_Gen5",
      "capacity": 2,
      "tier": "BusinessCritical"
    },
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "defaultSecondaryLocation": "North Europe",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "isInfraEncryptionEnabled": false,
    "isLedgerOn": false,
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "maxLogSizeBytes": 104857600,
    "maxSizeBytes": 268435456000,
    "readScale": "Enabled",
    "requestedBackupStorageRedundancy": "Geo",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "status": "Online",
    "zoneRedundant": false
  },
  "sku": {
    "name": "BC_Gen5",
    "capacity": 2,
    "tier": "BusinessCritical"
  }
}

Определения

Имя	Описание
AlwaysEncryptedEnclaveType	Тип анклава, запрошенного в базе данных, например по умолчанию или анклавов VBS.
AvailabilityZoneType	Указывает зону доступности, к ней закреплена база данных.
BackupStorageRedundancy	Тип учетной записи хранения, используемый для хранения резервных копий для этой базы данных.
CatalogCollationType	Параметры сортировки каталога метаданных.
createdByType	Тип удостоверения, создавшего ресурс.
CreateMode	Задает режим создания базы данных. По умолчанию: регулярное создание базы данных. Копирование: создает базу данных как копию существующей базы данных. sourceDatabaseId должен быть указан в качестве идентификатора ресурса исходной базы данных. Вторичный: создает базу данных в качестве вторичной реплики существующей базы данных. sourceDatabaseId должен быть указан в качестве идентификатора ресурса существующей базы данных-источника. PointInTimeRestore: создает базу данных путем восстановления резервной копии существующей базы данных на определенный момент времени. sourceDatabaseId необходимо указать в качестве идентификатора ресурса существующей базы данных, и необходимо указать restorePointInTime. Восстановление. Создание базы данных путем восстановления геореплицированной резервной копии. sourceDatabaseId необходимо указать в качестве идентификатора ресурса базы данных для восстановления. Восстановление. Создание базы данных путем восстановления резервной копии удаленной базы данных. необходимо указать sourceDatabaseId. Если sourceDatabaseId является исходным идентификатором ресурса базы данных, необходимо указать sourceDatabaseDeletionDeletionDate. В противном случае sourceDatabaseId должен быть идентификатором ресурса базы данных, который можно восстановить, и sourceDatabaseDeletionDeletionDate игнорируется. restorePointInTime также можно указать для восстановления с более ранней точки во времени. RestoreLongTermRetentionBackup: создает базу данных путем восстановления из долгосрочного хранилища хранения. RecoveryServicesRecoveryPointResourceId необходимо указать в качестве идентификатора ресурса точки восстановления. Копирование, вторичный и restoreLongTermRetentionBackup не поддерживается для выпуска DataWarehouse.
Database	Ресурс базы данных.
DatabaseIdentity	Azure Active Directory identity configuration for a resource.
DatabaseIdentityType	Тип удостоверения
DatabaseKey	Ключ уровня базы данных, используемый для шифрования неактивных данных.
DatabaseKeyType	Тип ключа базы данных. Поддерживается только значение AzureKeyVault.
DatabaseLicenseType	Тип лицензии, применяемый для этой базы данных. `LicenseIncluded`, если вам нужна лицензия, или `BasePrice`, если у вас есть лицензия и вы имеете право на Преимущество гибридного использования Azure.
DatabaseReadScale	Состояние маршрутизации только для чтения. Если включено, соединения с приложением intent установлен на readonly в их строка подключения могут быть маршрутизированы к вторичной реплике только для чтения в том же регионе. Неприменимо к базе данных гипермасштабирования в эластичном пуле.
DatabaseStatus	Состояние базы данных.
DatabaseUserIdentity	Azure Active Directory identity configuration for a resource.
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку
FreeLimitExhaustionBehavior	Указывает поведение, когда ежемесячные бесплатные ограничения исчерпаны для бесплатной базы данных. AutoPause: база данных будет автоматически приостановлена при исчерпании бесплатных ограничений на оставшуюся часть месяца. BillForUsage: база данных будет продолжать оставаться в сети после исчерпания бесплатных ограничений, и все превышение счетов будет выставлено.
SampleName	Имя примера схемы, применяемой при создании этой базы данных.
SecondaryType	Тип вторичной базы данных, если она является вторичной. Допустимыми значениями являются гео, именованные и резервные.
Sku	SKU ресурса ARM.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

AlwaysEncryptedEnclaveType

Перечисление

Тип анклава, запрошенного в базе данных, например по умолчанию или анклавов VBS.

Значение	Описание
Default	По умолчанию
VBS	VBS

AvailabilityZoneType

Перечисление

Указывает зону доступности, к ней закреплена база данных.

Значение	Описание
NoPreference	Отсутствие предпочтений
1	1
2	2
3	3

BackupStorageRedundancy

Перечисление

Тип учетной записи хранения, используемый для хранения резервных копий для этой базы данных.

Значение	Описание
Geo	Гео
Local	Локальный
Zone	Зона
GeoZone	GeoZone

CatalogCollationType

Перечисление

Параметры сортировки каталога метаданных.

Значение	Описание
DATABASE_DEFAULT	DATABASE_DEFAULT
SQL_Latin1_General_CP1_CI_AS	SQL_Latin1_General_CP1_CI_AS

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

CreateMode

Перечисление

Задает режим создания базы данных.

По умолчанию: регулярное создание базы данных.

Копирование: создает базу данных как копию существующей базы данных. sourceDatabaseId должен быть указан в качестве идентификатора ресурса исходной базы данных.

Вторичный: создает базу данных в качестве вторичной реплики существующей базы данных. sourceDatabaseId должен быть указан в качестве идентификатора ресурса существующей базы данных-источника.

PointInTimeRestore: создает базу данных путем восстановления резервной копии существующей базы данных на определенный момент времени. sourceDatabaseId необходимо указать в качестве идентификатора ресурса существующей базы данных, и необходимо указать restorePointInTime.

Восстановление. Создание базы данных путем восстановления геореплицированной резервной копии. sourceDatabaseId необходимо указать в качестве идентификатора ресурса базы данных для восстановления.

Восстановление. Создание базы данных путем восстановления резервной копии удаленной базы данных. необходимо указать sourceDatabaseId. Если sourceDatabaseId является исходным идентификатором ресурса базы данных, необходимо указать sourceDatabaseDeletionDeletionDate. В противном случае sourceDatabaseId должен быть идентификатором ресурса базы данных, который можно восстановить, и sourceDatabaseDeletionDeletionDate игнорируется. restorePointInTime также можно указать для восстановления с более ранней точки во времени.

RestoreLongTermRetentionBackup: создает базу данных путем восстановления из долгосрочного хранилища хранения. RecoveryServicesRecoveryPointResourceId необходимо указать в качестве идентификатора ресурса точки восстановления.

Копирование, вторичный и restoreLongTermRetentionBackup не поддерживается для выпуска DataWarehouse.

Значение	Описание
Default	По умолчанию
Copy	Копия
Secondary	Secondary
PointInTimeRestore	PointInTimeRestore
Restore	Restore
Recovery	Восстановление
RestoreExternalBackup	RestoreExternalBackup
RestoreExternalBackupSecondary	RestoreExternalBackupSecondary
RestoreLongTermRetentionBackup	RestoreLongTermRetentionBackup
OnlineSecondary	ОнлайнСредняя школа

Database

Объект

Ресурс базы данных.

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	DatabaseIdentity	Идентификация Azure Active Directory базы данных.
kind	string	Тип базы данных. Это метаданные, используемые для работы с порталом Azure.
location	string	Географическое расположение, в котором находится ресурс
managedBy	string	Ресурс, который управляет базой данных.
name	string	Имя ресурса
properties.autoPauseDelay	integer (int32)	Время в минутах после автоматической приостановки базы данных. Значение -1 означает, что автоматическая приостановка отключена
properties.availabilityZone	AvailabilityZoneType	Указывает зону доступности, к ней закреплена база данных.
properties.catalogCollation	CatalogCollationType	Параметры сортировки каталога метаданных.
properties.collation	string	Параметры сортировки базы данных.
properties.createMode	CreateMode	Задает режим создания базы данных. По умолчанию: регулярное создание базы данных. Копирование: создает базу данных как копию существующей базы данных. sourceDatabaseId должен быть указан в качестве идентификатора ресурса исходной базы данных. Вторичный: создает базу данных в качестве вторичной реплики существующей базы данных. sourceDatabaseId должен быть указан в качестве идентификатора ресурса существующей базы данных-источника. PointInTimeRestore: создает базу данных путем восстановления резервной копии существующей базы данных на определенный момент времени. sourceDatabaseId необходимо указать в качестве идентификатора ресурса существующей базы данных, и необходимо указать restorePointInTime. Восстановление. Создание базы данных путем восстановления геореплицированной резервной копии. sourceDatabaseId необходимо указать в качестве идентификатора ресурса базы данных для восстановления. Восстановление. Создание базы данных путем восстановления резервной копии удаленной базы данных. необходимо указать sourceDatabaseId. Если sourceDatabaseId является исходным идентификатором ресурса базы данных, необходимо указать sourceDatabaseDeletionDeletionDate. В противном случае sourceDatabaseId должен быть идентификатором ресурса базы данных, который можно восстановить, и sourceDatabaseDeletionDeletionDate игнорируется. restorePointInTime также можно указать для восстановления с более ранней точки во времени. RestoreLongTermRetentionBackup: создает базу данных путем восстановления из долгосрочного хранилища хранения. RecoveryServicesRecoveryPointResourceId необходимо указать в качестве идентификатора ресурса точки восстановления. Копирование, вторичный и restoreLongTermRetentionBackup не поддерживается для выпуска DataWarehouse.
properties.creationDate	string (date-time)	Дата создания базы данных (формат ISO8601).
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Тип учетной записи хранения, используемый для хранения резервных копий для этой базы данных.
properties.currentServiceObjectiveName	string	Текущее имя цели уровня обслуживания базы данных.
properties.currentSku	Sku	Имя и уровень номера SKU.
properties.databaseId	string (uuid)	Идентификатор базы данных.
properties.defaultSecondaryLocation	string	Регион-получатель по умолчанию для этой базы данных.
properties.earliestRestoreDate	string (date-time)	В этом отчете записывается самая ранняя дата начала и время восстановления, доступное для этой базы данных (ISO8601 формате).
properties.elasticPoolId	string (arm-id)	Идентификатор ресурса эластичного пула, содержащего эту базу данных.
properties.encryptionProtector	string	URI хранилища ключей Azure базы данных, если она настроена с использованием ключей, управляемых клиентом базы данных.
properties.encryptionProtectorAutoRotation	boolean	Флаг для включения или отключения автоматического поворота ключа AKV шифрования базы данных.
properties.failoverGroupId	string	Идентификатор ресурса группы отработки отказа, к которому принадлежит эта база данных.
properties.federatedClientId	string (uuid)	Идентификатор клиента, используемый для межтенантного сценария CMK для каждой базы данных
properties.freeLimitExhaustionBehavior	FreeLimitExhaustionBehavior	Указывает поведение, когда ежемесячные бесплатные ограничения исчерпаны для бесплатной базы данных. AutoPause: база данных будет автоматически приостановлена при исчерпании бесплатных ограничений на оставшуюся часть месяца. BillForUsage: база данных будет продолжать оставаться в сети после исчерпания бесплатных ограничений, и все превышение счетов будет выставлено.
properties.highAvailabilityReplicaCount	integer (int32)	Количество вторичных реплик, связанных с базой данных выпуска "Критически важный для бизнеса", "Премиум" или "Гипермасштабирование", используемых для обеспечения высокой доступности. Неприменимо к базе данных гипермасштабирования в эластичном пуле.
properties.isInfraEncryptionEnabled	boolean	Для этой базы данных включено шифрование с помощью инфракрасного шифрования.
properties.isLedgerOn	boolean	Независимо от того, является ли эта база данных базой данных реестра, то есть все таблицы в базе данных являются таблицами реестра. Примечание. Значение этого свойства невозможно изменить после создания базы данных.
properties.keys	<string, DatabaseKey>	Идентификаторы ресурса назначенных пользователем удостоверений для использования
properties.licenseType	DatabaseLicenseType	Тип лицензии, применяемый для этой базы данных. `LicenseIncluded`, если вам нужна лицензия, или `BasePrice`, если у вас есть лицензия и вы имеете право на Преимущество гибридного использования Azure.
properties.longTermRetentionBackupResourceId	string (arm-id)	Идентификатор ресурса долгосрочной резервной копии хранения, связанной с операцией создания этой базы данных.
properties.maintenanceConfigurationId	string	Идентификатор конфигурации обслуживания, назначенный базе данных. Эта конфигурация определяет период, когда будут выполняться обновления обслуживания.
properties.manualCutover	boolean	Требуется ли выполнить переход вручную, контролируемый клиентом, во время операции "Обновить базу данных" на уровень "Гипермасштабирование". Это свойство применимо только при масштабировании базы данных из уровня "Критически важный для бизнеса", "Общего назначения", "Премиум"/ "Стандартный" на уровень "Гипермасштабирование". При указании вручнуюCutover операция масштабирования будет ожидать, пока входные данные пользователя активируют переключение в базу данных Гипермасштабирования. Чтобы активировать переключение, укажите параметр "performCutover", когда операция масштабирования находится в состоянии ожидания.
properties.maxLogSizeBytes	integer (int64)	Максимальный размер журнала для этой базы данных.
properties.maxSizeBytes	integer (int64)	Максимальный размер базы данных, выраженный в байтах.
properties.minCapacity	number (double)	Минимальная емкость, которую база данных всегда будет выделена, если она не приостановлена
properties.pausedDate	string (date-time)	Дата приостановки базы данных с помощью пользовательской конфигурации или действия (ISO8601 формата). Значение NULL, если база данных готова.
properties.performCutover	boolean	Для активации управляемой клиентом ручной переключения во время выполнения операции масштабирования. Этот параметр свойства применим только для операций масштабирования, инициируемых вместе с параметром ManualCutover. Это свойство применимо только при масштабировании базы данных с уровня "Критически важный для бизнеса", "Общего назначения", "Премиум"/ "Стандартный" на уровень "Гипермасштабирование". При указании performCutover операция масштабирования активирует переключение и выполняет изменение роли в базе данных Гипермасштабирования.
properties.preferredEnclaveType	AlwaysEncryptedEnclaveType	Тип анклава, запрошенного в базе данных, например по умолчанию или анклавов VBS.
properties.readScale	DatabaseReadScale	Состояние маршрутизации только для чтения. Если включено, соединения с приложением intent установлен на readonly в их строка подключения могут быть маршрутизированы к вторичной реплике только для чтения в том же регионе. Неприменимо к базе данных гипермасштабирования в эластичном пуле.
properties.recoverableDatabaseId	string (arm-id)	Идентификатор ресурса восстанавливаемой базы данных, связанной с операцией создания этой базы данных.
properties.recoveryServicesRecoveryPointId	string (arm-id)	Идентификатор ресурса точки восстановления, связанной с операцией создания этой базы данных.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Тип учетной записи хранения, используемый для хранения резервных копий для этой базы данных.
properties.requestedServiceObjectiveName	string	Запрошенное имя цели уровня обслуживания базы данных.
properties.restorableDroppedDatabaseId	string (arm-id)	Идентификатор ресурса восстанавливаемой удаленной базы данных, связанной с операцией создания этой базы данных.
properties.restorePointInTime	string (date-time)	Указывает точку во времени (ISO8601 формате) исходной базы данных, которая будет восстановлена для создания новой базы данных.
properties.resumedDate	string (date-time)	Дата возобновления базы данных с помощью действия пользователя или имени входа базы данных (ISO8601 формате). Значение NULL, если база данных приостановлена.
properties.sampleName	SampleName	Имя примера схемы, применяемой при создании этой базы данных.
properties.secondaryType	SecondaryType	Тип вторичной базы данных, если она является вторичной. Допустимыми значениями являются гео, именованные и резервные.
properties.sourceDatabaseDeletionDate	string (date-time)	Указывает время удаления базы данных.
properties.sourceDatabaseId	string (arm-id)	Идентификатор ресурса исходной базы данных, связанной с операцией создания этой базы данных.
properties.sourceResourceId	string (arm-id)	Идентификатор ресурса источника, связанного с операцией создания этой базы данных. Это свойство поддерживается только для выпуска DataWarehouse и позволяет восстанавливаться в подписках. Если задан sourceResourceId, sourceDatabaseId, restoreableDatabaseId, restoreableDroppedDatabaseId и sourceDatabaseDeletionDeletionDate, а CreateMode должно быть PointInTimeRestore, Restore или Restore. Если createMode — PointInTimeRestore, sourceResourceId должен быть идентификатором ресурса существующей базы данных или существующего пула SQL, а также необходимо указать restorePointInTime. При созданииmode — restore, sourceResourceId должен быть идентификатором ресурса восстанавливаемой удаленной базы данных или восстанавливаемым пулом SQL. При создании объекта CreateMode is Recover источникResourceId должен быть идентификатором ресурса восстанавливаемой базы данных или пула sql с возможностью восстановления. Если исходная подписка принадлежит к клиенту, отличному от целевой подписки, заголовок x-ms-authorization-вспомогательный должен содержать маркер проверки подлинности для исходного клиента. Дополнительные сведения о заголовке x-ms-authorization-вспомогательный см. в https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
properties.status	DatabaseStatus	Состояние базы данных.
properties.useFreeLimit	boolean	Независимо от того, использует ли база данных бесплатные ежемесячные ограничения. Разрешено для одной базы данных в подписке.
properties.zoneRedundant	boolean	Независимо от того, является ли эта база данных избыточной по зонам, то есть реплики этой базы данных будут распространяться по нескольким зонам доступности.
sku	Sku	Номер SKU базы данных. Список номеров SKU может отличаться по регионам и предложению поддержки. Чтобы определить SKU (включая имя, уровень/издание, семейство и емкость), доступные вашей подписке в Azure регионе, используйте API REST `Capabilities_ListByLocation` или одну из следующих команд: `az sql db list-editions -l <location> -o table` `Get-AzSqlServerServiceObjective -Location <location>`
systemData	systemData	Azure Resource Manager метаданные, содержащие информацию createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, «Майкрософт. Compute/virtualMachines» или «Майкрософт. Аккаунты хранения/хранения»

DatabaseIdentity

Объект

Azure Active Directory identity configuration for a resource.

Имя	Тип	Описание
tenantId	string (uuid)	The Azure Active Directory tenant id.
type	DatabaseIdentityType	Тип удостоверения
userAssignedIdentities	<string, DatabaseUserIdentity>	Идентификаторы ресурса назначенных пользователем удостоверений для использования

DatabaseIdentityType

Перечисление

Тип удостоверения

Значение	Описание
None	Нет
UserAssigned	UserAssigned

DatabaseKey

Объект

Ключ уровня базы данных, используемый для шифрования неактивных данных.

Имя	Тип	Описание
creationDate	string (date-time)	Дата создания ключа базы данных.
keyVersion	string	Версия ключа базы данных.
subregion	string	Поверх ключа сервера.
thumbprint	string	Отпечаток ключа базы данных.
type	DatabaseKeyType	Тип ключа базы данных. Поддерживается только значение AzureKeyVault.

DatabaseKeyType

Перечисление

Тип ключа базы данных. Поддерживается только значение AzureKeyVault.

Значение	Описание
AzureKeyVault	AzureKeyVault

DatabaseLicenseType

Перечисление

Тип лицензии, применяемый для этой базы данных. LicenseIncluded, если вам нужна лицензия, или BasePrice, если у вас есть лицензия и вы имеете право на Преимущество гибридного использования Azure.

Значение	Описание
LicenseIncluded	ЛицензияВключено
BasePrice	BasePrice

DatabaseReadScale

Перечисление

Состояние маршрутизации только для чтения. Если включено, соединения с приложением intent установлен на readonly в их строка подключения могут быть маршрутизированы к вторичной реплике только для чтения в том же регионе. Неприменимо к базе данных гипермасштабирования в эластичном пуле.

Значение	Описание
Enabled	Enabled
Disabled	Disabled

DatabaseStatus

Перечисление

Состояние базы данных.

Значение	Описание
Online	Онлайн
Restoring	Восстановление
RecoveryPending	ВосстановлениеВ ожидании
Recovering	восстановление;
Suspect	Подозревать
Offline	Не в сети
Standby	Режим ожидания
Shutdown	Завершение работы
EmergencyMode	Режим экстренной ситуации
AutoClosed	AutoClosed
Copying	Копирование
Creating	Создавать
Inaccessible	Недосягаемый
OfflineSecondary	АвтономныйВторичный
Pausing	Приостановка
Paused	Приостановлено
Resuming	Продолжение
Scaling	Масштабирование
OfflineChangingDwPerformanceTiers	OfflineChanging DwPerformanceTiers
OnlineChangingDwPerformanceTiers	OnlineChangingDwPerformanceTiers
Disabled	Disabled
Stopping	Остановка
Stopped	Остановился
Starting	Запуск

DatabaseUserIdentity

Объект

Azure Active Directory identity configuration for a resource.

Имя	Тип	Описание
clientId	string (uuid)	The Azure Active Directory client id.
principalId	string (uuid)	The Azure Active Directory principal id.

ErrorAdditionalInfo

Объект

Ошибка управления ресурсами дополнительная информация.

Имя	Тип	Описание
info	object	Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Объект

Детали ошибки.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

FreeLimitExhaustionBehavior

Перечисление

Указывает поведение, когда ежемесячные бесплатные ограничения исчерпаны для бесплатной базы данных.

AutoPause: база данных будет автоматически приостановлена при исчерпании бесплатных ограничений на оставшуюся часть месяца.

BillForUsage: база данных будет продолжать оставаться в сети после исчерпания бесплатных ограничений, и все превышение счетов будет выставлено.

Значение	Описание
AutoPause	Автопауза
BillOverUsage	OverUsage Bill

SampleName

Перечисление

Имя примера схемы, применяемой при создании этой базы данных.

Значение	Описание
AdventureWorksLT	AdventureWorksLT
WideWorldImportersStd	WideWorldImportersStd
WideWorldImportersFull	WideWorldImportersFull

SecondaryType

Перечисление

Тип вторичной базы данных, если она является вторичной. Допустимыми значениями являются гео, именованные и резервные.

Значение	Описание
Geo	Гео
Named	Назван
Standby	Режим ожидания

Sku

Объект

SKU ресурса ARM.

Имя	Тип	Описание
capacity	integer (int32)	Емкость конкретного номера SKU.
family	string	Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь.
name	string	Имя номера SKU, как правило, буква + код номера, например P3.
size	string	Размер конкретного номера SKU
tier	string	Уровень или выпуск конкретного номера SKU, например "Базовый", "Премиум".

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Временная метка последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

Databases - Get

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

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 using versionless keys.

Образец запроса

Пример ответа

Gets a database with database level keys expanded.

Образец запроса

Пример ответа

Gets a database.

Образец запроса

Пример ответа

Определения

AlwaysEncryptedEnclaveType

AvailabilityZoneType

BackupStorageRedundancy

CatalogCollationType

createdByType

CreateMode

Database

DatabaseIdentity

DatabaseIdentityType

DatabaseKey

DatabaseKeyType

DatabaseLicenseType

DatabaseReadScale

DatabaseStatus

DatabaseUserIdentity

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FreeLimitExhaustionBehavior

SampleName

SecondaryType

Sku

systemData