Databases - List By Server

Ссылка

Служба:: SQL Database

Версия API:: 2021-11-01

Возвращает список баз данных.

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

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования в запросе.
$skipToken	query		string

Ответы

Имя	Тип	Описание
200 OK	DatabaseListResult	Список баз данных успешно получен.
Other Status Codes		Ответы на ошибки: *** 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке.

Имя

Тип

Описание

200 OK

DatabaseListResult

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

Other Status Codes

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

404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден
404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке.

Примеры

Gets a list of databases.

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


/**
 * Samples for Databases ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListVCoreDatabasesByServer.json
     */
    /**
     * Sample code: Gets a list of databases.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsAListOfDatabases(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabases().listByServer("Default-SQL-SouthEastAsia", "testsvr",
            null, 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

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

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

{
  "value": [
    {
      "sku": {
        "name": "BC_Gen4",
        "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_Gen4_2",
        "requestedServiceObjectiveName": "BC_Gen4_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",
        "currentSku": {
          "name": "BC_Gen4",
          "tier": "BusinessCritical",
          "capacity": 2
        },
        "currentBackupStorageRedundancy": "Zone",
        "requestedBackupStorageRedundancy": "Zone",
        "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"
    },
    {
      "sku": {
        "name": "System0",
        "tier": "System",
        "capacity": 0
      },
      "kind": "v12.0,system",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 32212254720,
        "status": "Online",
        "databaseId": "e6be351f-2cc9-4604-9e52-b0b28b2710b0",
        "creationDate": "2017-06-07T04:23:42.537Z",
        "currentServiceObjectiveName": "System0",
        "requestedServiceObjectiveName": "System0",
        "defaultSecondaryLocation": "North Europe",
        "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
        "isInfraEncryptionEnabled": false,
        "zoneRedundant": false,
        "readScale": "Disabled",
        "currentSku": {
          "name": "System0",
          "tier": "System",
          "capacity": 0
        },
        "currentBackupStorageRedundancy": "Local",
        "requestedBackupStorageRedundancy": "Local",
        "isLedgerOn": false
      },
      "location": "southeastasia",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/master",
      "name": "master",
      "type": "Microsoft.Sql/servers/databases"
    }
  ]
}

Определения

Имя	Описание
BackupStorageRedundancy	Тип учетной записи хранения, используемый для хранения резервных копий для этой базы данных.
CatalogCollationType	Параметры сортировки каталога метаданных.
CreateMode	Указывает режим создания базы данных. По умолчанию: регулярное создание базы данных. Копировать: создает базу данных как копию существующей базы данных. sourceDatabaseId должен быть указан в качестве идентификатора ресурса базы данных-источника. -получатель: создает базу данных как реплика-получатель существующей базы данных. SourceDatabaseId должен быть указан в качестве идентификатора ресурса существующей базы данных-источника. PointInTimeRestore. Создает базу данных путем восстановления резервной копии существующей базы данных на определенный момент времени. sourceDatabaseId необходимо указать в качестве идентификатора ресурса существующей базы данных, а также параметр restorePointInTime. Восстановление. Создает базу данных путем восстановления геореплицированной резервной копии. sourceDatabaseId должен быть указан в качестве идентификатора ресурса восстанавливаемой базы данных для восстановления. Восстановление. Создает базу данных путем восстановления резервной копии удаленной базы данных. Необходимо указать sourceDatabaseId. Если sourceDatabaseId является исходным идентификатором ресурса базы данных, необходимо указать sourceDatabaseDeletionDate. В противном случае sourceDatabaseId должен быть восстанавливаемым идентификатором удаленного ресурса базы данных, а sourceDatabaseDeletionDate игнорируется. Параметр restorePointInTime также может быть указан для восстановления с более ранней точки во времени. RestoreLongTermRetentionBackup: создает базу данных путем восстановления из хранилища долгосрочного хранения. recoveryServicesRecoveryPointResourceId должен быть указан в качестве идентификатора ресурса точки восстановления. Copy, Secondary и RestoreLongTermRetentionBackup не поддерживаются для выпусков DataWarehouse.
Database	Ресурс базы данных.
DatabaseIdentity	Конфигурация удостоверения Azure Active Directory для ресурса.
DatabaseIdentityType	Тип удостоверения
DatabaseLicenseType	Тип лицензии, применяемой для этой базы данных. `LicenseIncluded`если вам нужна лицензия или `BasePrice` если у вас есть лицензия и вы имеете право на Преимущество гибридного использования Azure.
DatabaseListResult	Список баз данных.
DatabaseReadScale	Состояние маршрутизации только для чтения. Если этот параметр включен, подключения с намерением приложения, для которых настроено только чтение в строка подключения, могут направляться в дополнительный реплика только для чтения в том же регионе. Неприменимо к базе данных с гипермасштабированием в эластичном пуле.
DatabaseStatus	Состояние базы данных.
DatabaseUserIdentity	Конфигурация удостоверений Azure Active Directory для ресурса.
SampleName	Имя примера схемы, применяемой при создании этой базы данных.
SecondaryType	Тип-получатель базы данных, если она является вторичной. Допустимые значения: Geo и Named.
Sku	SKU ресурса ARM.

BackupStorageRedundancy

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

Имя	Тип	Описание
Geo	string
GeoZone	string
Local	string
Zone	string

CatalogCollationType

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

Имя	Тип	Описание
DATABASE_DEFAULT	string
SQL_Latin1_General_CP1_CI_AS	string

CreateMode

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

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

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

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

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

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

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

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

Copy, Secondary и RestoreLongTermRetentionBackup не поддерживаются для выпусков DataWarehouse.

Имя	Тип	Описание
Copy	string
Default	string
OnlineSecondary	string
PointInTimeRestore	string
Recovery	string
Restore	string
RestoreExternalBackup	string
RestoreExternalBackupSecondary	string
RestoreLongTermRetentionBackup	string
Secondary	string

Database

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

Имя	Тип	Описание
id	string	Идентификатор ресурса.
identity	DatabaseIdentity	Удостоверение Azure Active Directory базы данных.
kind	string	Тип базы данных. Это метаданные, используемые для портал Azure взаимодействия.
location	string	Расположение ресурса.
managedBy	string	Ресурс, который управляет базой данных.
name	string	Имя ресурса.
properties.autoPauseDelay	integer	Время в минутах, после которого база данных автоматически приостанавливается. Значение -1 означает, что автоматическая приостановка отключена.
properties.catalogCollation	CatalogCollationType	Параметры сортировки каталога метаданных.
properties.collation	string	Параметры сортировки базы данных.
properties.createMode	CreateMode	Указывает режим создания базы данных. По умолчанию: регулярное создание базы данных. Копировать: создает базу данных как копию существующей базы данных. sourceDatabaseId необходимо указать в качестве идентификатора ресурса базы данных-источника. Получатель: создает базу данных в качестве реплика-получателя существующей базы данных. SourceDatabaseId необходимо указать в качестве идентификатора ресурса существующей базы данных-источника. PointInTimeRestore. Создает базу данных путем восстановления резервной копии существующей базы данных на определенный момент времени. SourceDatabaseId необходимо указать в качестве идентификатора ресурса существующей базы данных, а также параметр restorePointInTime. Восстановление. Создает базу данных путем восстановления геореплицированной резервной копии. SourceDatabaseId необходимо указать в качестве идентификатора ресурса восстанавливаемой базы данных для восстановления. Восстановление. Создает базу данных путем восстановления резервной копии удаленной базы данных. Необходимо указать sourceDatabaseId. Если sourceDatabaseId является исходным идентификатором ресурса базы данных, необходимо указать sourceDatabaseDeletionDate. В противном случае sourceDatabaseId должен быть восстанавливаемым идентификатором удаленного ресурса базы данных, а sourceDatabaseDeletionDate игнорируется. Также можно указать restorePointInTime для восстановления с более ранней точки во времени. RestoreLongTermRetentionBackup: создает базу данных путем восстановления из хранилища долгосрочного хранения. recoveryServicesRecoveryPointResourceId должен быть указан в качестве идентификатора ресурса точки восстановления. Copy, Secondary и RestoreLongTermRetentionBackup не поддерживаются для выпуска DataWarehouse.
properties.creationDate	string	Дата создания базы данных (ISO8601 формате).
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Тип учетной записи хранения, используемой для хранения резервных копий для этой базы данных.
properties.currentServiceObjectiveName	string	Текущее целевое имя уровня обслуживания базы данных.
properties.currentSku	Sku	Имя и уровень номера SKU.
properties.databaseId	string	Идентификатор базы данных.
properties.defaultSecondaryLocation	string	Регион-получатель по умолчанию для этой базы данных.
properties.earliestRestoreDate	string	В ней записываются самые ранние дата и время начала восстановления для этой базы данных (ISO8601 формате).
properties.elasticPoolId	string	Идентификатор ресурса эластичного пула, содержащего эту базу данных.
properties.failoverGroupId	string	Идентификатор ресурса группы отработки отказа, к которой принадлежит эта база данных.
properties.federatedClientId	string	Идентификатор клиента, используемый для сценария CMK между клиентами для базы данных
properties.highAvailabilityReplicaCount	integer	Количество вторичных реплик, связанных с базой данных, которые используются для обеспечения высокого уровня доступности. Неприменимо к базе данных уровня "Гипермасштабирование" в эластичном пуле.
properties.isInfraEncryptionEnabled	boolean	Для этой базы данных включено инфракрасное шифрование.
properties.isLedgerOn	boolean	Является ли эта база данных базой данных реестра. Это означает, что все таблицы в базе данных являются таблицами реестра. Примечание. Значение этого свойства нельзя изменить после создания базы данных.
properties.licenseType	DatabaseLicenseType	Тип лицензии, применяемой для этой базы данных. `LicenseIncluded`если вам нужна лицензия или `BasePrice` если у вас есть лицензия и вы имеете право на Преимущество гибридного использования Azure.
properties.longTermRetentionBackupResourceId	string	Идентификатор ресурса резервной копии долгосрочного хранения, связанной с операцией создания этой базы данных.
properties.maintenanceConfigurationId	string	Идентификатор конфигурации обслуживания, назначенный базе данных. Эта конфигурация определяет период, когда будут выполняться обновления обслуживания.
properties.maxLogSizeBytes	integer	Максимальный размер журнала для этой базы данных.
properties.maxSizeBytes	integer	Максимальный размер базы данных, выраженный в байтах.
properties.minCapacity	number	Минимальная емкость, которую база данных всегда будет выделять, если она не приостановлена
properties.pausedDate	string	Дата приостановки базы данных с помощью пользовательской конфигурации или действия (ISO8601 формате). Значение NULL, если база данных готова.
properties.readScale	DatabaseReadScale	Состояние маршрутизации только для чтения. Если этот параметр включен, подключения, для которых в строка подключения настроено намерение приложения только для чтения, могут направляться на дополнительный реплика только для чтения в том же регионе. Неприменимо к базе данных уровня "Гипермасштабирование" в эластичном пуле.
properties.recoverableDatabaseId	string	Идентификатор ресурса восстанавливаемой базы данных, связанной с операцией создания этой базы данных.
properties.recoveryServicesRecoveryPointId	string	Идентификатор ресурса точки восстановления, связанной с операцией создания этой базы данных.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Тип учетной записи хранения, используемой для хранения резервных копий для этой базы данных.
properties.requestedServiceObjectiveName	string	Запрошенное целевое имя уровня обслуживания базы данных.
properties.restorableDroppedDatabaseId	string	Идентификатор ресурса восстанавливаемой базы данных, связанной с операцией создания этой базы данных.
properties.restorePointInTime	string	Указывает точку во времени (ISO8601 формат) базы данных-источника, которая будет восстановлена для создания новой базы данных.
properties.resumedDate	string	Дата возобновления базы данных с помощью действия пользователя или имени входа в базу данных (ISO8601 формате). Значение NULL, если база данных приостановлена.
properties.sampleName	SampleName	Имя примера схемы, применяемой при создании этой базы данных.
properties.secondaryType	SecondaryType	Тип-получатель базы данных, если это база данных-получатель. Допустимые значения: Geo и Named.
properties.sourceDatabaseDeletionDate	string	Указывает время удаления базы данных.
properties.sourceDatabaseId	string	Идентификатор ресурса базы данных-источника, связанной с операцией создания этой базы данных.
properties.sourceResourceId	string	Идентификатор ресурса источника, связанного с операцией создания этой базы данных. Это свойство поддерживается только для выпуска DataWarehouse и позволяет выполнять восстановление в разных подписках. При указании sourceResourceId не следует указывать sourceDatabaseId, recoverableDatabaseId, restoreableDroppedDatabaseId и sourceDatabaseDeletionDate, а параметр CreateMode должен иметь значение PointInTimeRestore, Restore или Recover. Если параметр createMode имеет значение PointInTimeRestore, sourceResourceId должен быть идентификатором ресурса существующей базы данных или пула SQL, а также должен быть указан параметр restorePointInTime. Если параметр createMode имеет значение Restore, sourceResourceId должен быть идентификатором ресурса восстанавливаемой удаленной базы данных или пула SQL, который можно восстановить. Если параметр createMode имеет значение Recover, sourceResourceId должен быть идентификатором ресурса восстанавливаемой базы данных или восстанавливаемого пула SQL. Если исходная подписка принадлежит клиенту, отличному от целевой, заголовок x-ms-authorization-auxiliary должен содержать маркер проверки подлинности для исходного клиента. Дополнительные сведения о заголовке x-ms-authorization-auxiliary см. в разделе https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
properties.status	DatabaseStatus	Состояние базы данных.
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

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

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

DatabaseIdentityType

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

Имя	Тип	Описание
None	string
UserAssigned	string

DatabaseLicenseType

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

Имя	Тип	Описание
BasePrice	string
LicenseIncluded	string

DatabaseListResult

Список баз данных.

Имя	Тип	Описание
nextLink	string	Ссылка для получения следующей страницы результатов.
value	Database[]	Массив результатов.

DatabaseReadScale

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

Имя	Тип	Описание
Disabled	string
Enabled	string

DatabaseStatus

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

Имя	Тип	Описание
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

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

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

SampleName

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

Имя	Тип	Описание
AdventureWorksLT	string
WideWorldImportersFull	string
WideWorldImportersStd	string

SecondaryType

Тип-получатель базы данных, если она является вторичной. Допустимые значения: Geo и Named.

Имя	Тип	Описание
Geo	string
Named	string

Sku

SKU ресурса ARM.

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

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

Databases - List By Server

Параметры URI

Ответы

Примеры

Gets a list of databases.

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

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

Определения

BackupStorageRedundancy

CatalogCollationType

CreateMode

Database

DatabaseIdentity

DatabaseIdentityType

DatabaseLicenseType

DatabaseListResult

DatabaseReadScale

DatabaseStatus

DatabaseUserIdentity

SampleName

SecondaryType

Sku

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