Databases - Get

Ссылка

Служба:: SQL Database

Версия API:: 2023-08-01

Возвращает базу данных.

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

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
databaseName	path	True	string	Имя базы данных.
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки, идентифицирующий подписку Azure.
api-version	query	True	string	Версия API, используемая для запроса.
$expand	query		string	Дочерние ресурсы для включения в ответ.
$filter	query		string	Выражение фильтра OData, которое фильтрует элементы в коллекции.

Ответы

Имя	Тип	Описание
200 OK	Database	Успешно получена указанная база данных.
Other Status Codes	ErrorResponse	Ответы на ошибки: *** 400 ManagedInstanceStoppingOrStoppingOrStopped — конфликтующая операция, отправленная во время остановки или остановки экземпляра 400 ManagedInstanceStarting — конфликтующая операция, отправленная во время запуска экземпляра 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке. 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 ResourceNotFound — запрошенный ресурс не найден.

Имя

Тип

Описание

200 OK

Database

Успешно получена указанная база данных.

Other Status Codes

ErrorResponse

Ответы на ошибки: ***

400 ManagedInstanceStoppingOrStoppingOrStopped — конфликтующая операция, отправленная во время остановки или остановки экземпляра
400 ManagedInstanceStarting — конфликтующая операция, отправленная во время запуска экземпляра
404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке.
404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден
404 ResourceNotFound — запрошенный ресурс не найден.

Примеры

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.

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=2023-08-01

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

Код состояния:: 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,
    "preferredEnclaveType": "Default"
  },
  "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"
}

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=2023-08-01

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

Код состояния:: 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,
    "preferredEnclaveType": "VBS"
  },
  "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"
}

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=2023-08-01

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

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

{
  "sku": {
    "name": "S0",
    "tier": "Standard",
    "capacity": 10
  },
  "kind": "v12.0,user",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 1073741824,
    "status": "Online",
    "currentSku": {
      "name": "Standard",
      "tier": "Standard",
      "capacity": 10
    },
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentBackupStorageRedundancy": "Geo",
    "currentServiceObjectiveName": "S0",
    "defaultSecondaryLocation": "North Europe",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "readScale": "Disabled",
    "requestedBackupStorageRedundancy": "Geo",
    "requestedServiceObjectiveName": "S0",
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "isLedgerOn": false,
    "availabilityZone": "1"
  },
  "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"
}

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?$expand=keys&api-version=2023-08-01

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

Код состояния:: 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,
    "keys": {
      "https://your-key-vault-name.vault.azure.net/yourKey/yourKeyVersion": {},
      "https://your-key-vault-name.vault.azure.net/yourKey2/yourKey2Version": {}
    },
    "encryptionProtector": "https://your-key-vault-name.vault.azure.net/yourKey/yourKeyVersion"
  },
  "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"
}

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=2023-08-01

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

Код состояния:: 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"
}

Определения

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

AlwaysEncryptedEnclaveType

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

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

Значение	Описание
Default
VBS

AvailabilityZoneType

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

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

Значение	Описание
1
2
3
NoPreference

BackupStorageRedundancy

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

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

Значение	Описание
Geo
GeoZone
Local
Zone

CatalogCollationType

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

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

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

CreateMode

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

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

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

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

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

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

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

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

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

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

Значение	Описание
Copy
Default
OnlineSecondary
PointInTimeRestore
Recovery
Restore
RestoreExternalBackup
RestoreExternalBackupSecondary
RestoreLongTermRetentionBackup
Secondary

Database

Object

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

Имя	Тип	Описание
id	string	Идентификатор ресурса.
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	Состояние маршрутизации только для чтения. Если этот параметр включен, подключения с намерением приложения, которые настроены для чтения в их строке подключения, могут быть перенаправлены на вторичную реплику чтения в том же регионе. Неприменимо к базе данных гипермасштабирования в эластичном пуле.
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 (включая имя SKU, уровень или выпуск, семейство и емкость), доступные в вашей подписке в регионе Azure, используйте `Capabilities_ListByLocation` REST API или одну из следующих команд: `az sql db list-editions -l <location> -o table` `Get-AzSqlServerServiceObjective -Location <location>`
tags	object	Теги ресурсов.
type	string	Тип ресурса.

DatabaseIdentity

Object

Конфигурация удостоверений Azure Active Directory для ресурса.

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

DatabaseIdentityType

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

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

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

DatabaseKey

Object

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

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

DatabaseKeyType

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

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

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

DatabaseLicenseType

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

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

Значение	Описание
BasePrice
LicenseIncluded

DatabaseReadScale

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

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

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

DatabaseStatus

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

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

Значение	Описание
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

Object

Конфигурация удостоверений Azure Active Directory для ресурса.

Имя	Тип	Описание
clientId	string (uuid)	Идентификатор клиента Azure Active Directory.
principalId	string (uuid)	Идентификатор субъекта Azure Active Directory.

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

Сведения об ошибке.

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

ErrorResponse

Object

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

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

FreeLimitExhaustionBehavior

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

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

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

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

Значение	Описание
AutoPause
BillOverUsage

SampleName

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

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

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

SecondaryType

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

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

Значение	Описание
Geo
Named
Standby

Sku

Object

SKU ресурса ARM.

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

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

Databases - Get

Параметры URI

Ответы

Примеры

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.

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

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

Gets a database.

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

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

Определения

AlwaysEncryptedEnclaveType

AvailabilityZoneType

BackupStorageRedundancy

CatalogCollationType

CreateMode

Database

DatabaseIdentity

DatabaseIdentityType

DatabaseKey

DatabaseKeyType

DatabaseLicenseType

DatabaseReadScale

DatabaseStatus

DatabaseUserIdentity

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FreeLimitExhaustionBehavior

SampleName

SecondaryType

Sku

Дополнительные ресурсы