Databases - List By Elastic Pool

Возвращает список баз данных в эластичном пуле.

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

Параметры URI

Name In Required Type Description
elasticPoolName
path True
  • string

Имя эластичного пула.

resourceGroupName
path True
  • string

Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.

serverName
path True
  • string

Имя сервера.

subscriptionId
path True
  • string

Идентификатор подписки Azure.

api-version
query True
  • string

Версия API для использования в запросе.

Ответы

Name Type Description
200 OK

Успешно получен список баз данных в эластичном пуле.

Other Status Codes

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

  • 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден

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

  • 404 CannotFindObject — не удается найти объект, так как он не существует или у вас нет разрешений

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

  • 404 ServerNotInSubscription — указанный сервер не существует в указанной подписке.

  • 429 SubscriptionTooManyCreateUpdateRequests — запросы за пределами максимального числа запросов, которые могут обрабатываться доступными ресурсами.

  • 429 SubscriptionTooManyRequests — запросы, превышающие максимальное количество запросов, которые могут обрабатываться доступными ресурсами.

  • 503 TooManyRequests — запросы, превышающие максимальное количество запросов, которые могут обрабатываться доступными ресурсами.

  • 504 RequestTimeout — запрос на обслуживание превысил допустимое время ожидания.

Примеры

Gets a list of databases in an elastic pool.

Sample Request

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

Sample Response

{
  "value": [
    {
      "sku": {
        "name": "ElasticPool",
        "tier": "Standard"
      },
      "kind": "v12.0,user",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 268435456000,
        "elasticPoolId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/elasticPools/Pool1",
        "status": "Online",
        "databaseId": "bfe0735f-bc87-447f-b2c2-481f4b100614",
        "creationDate": "2017-07-12T22:08:39.163Z",
        "currentServiceObjectiveName": "ElasticPool",
        "defaultSecondaryLocation": "North Europe",
        "catalogCollation": "SQL_Latin1_General_CP1_CI_AS"
      },
      "location": "southeastasia",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/DB001",
      "name": "DB001",
      "type": "Microsoft.Sql/servers/databases"
    },
    {
      "sku": {
        "name": "ElasticPool",
        "tier": "Standard"
      },
      "kind": "v12.0,user",
      "properties": {
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "maxSizeBytes": 268435456000,
        "elasticPoolId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/elasticPools/Pool1",
        "status": "Online",
        "databaseId": "82246152-3177-4357-b81c-a16d87ce3593",
        "creationDate": "2017-07-12T22:10:10.773Z",
        "currentServiceObjectiveName": "ElasticPool",
        "defaultSecondaryLocation": "North Europe",
        "catalogCollation": "SQL_Latin1_General_CP1_CI_AS"
      },
      "location": "southeastasia",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/DB002",
      "name": "DB002",
      "type": "Microsoft.Sql/servers/databases"
    }
  ]
}

Определения

BackupStorageRedundancy

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

CatalogCollationType

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

CreateMode

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

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

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

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

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

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

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

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

Копирование, вторичная и 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

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

Name Type Description
Geo
  • string
GeoZone
  • string
Local
  • string
Zone
  • string

CatalogCollationType

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

Name Type Description
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 необходимо указать в качестве идентификатора ресурса точки восстановления.

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

Name Type Description
Copy
  • string
Default
  • string
OnlineSecondary
  • string
PointInTimeRestore
  • string
Recovery
  • string
Restore
  • string
RestoreExternalBackup
  • string
RestoreExternalBackupSecondary
  • string
RestoreLongTermRetentionBackup
  • string
Secondary
  • string

Database

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

Name Type Description
id
  • string

Идентификатор ресурса.

identity

Удостоверение базы данных Azure Active Directory.

kind
  • string

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

location
  • string

Расположение ресурса.

managedBy
  • string

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

name
  • string

Имя ресурса.

properties.autoPauseDelay
  • integer

Время в минутах после автоматической приостановки базы данных. Значение -1 означает, что автоматическая пауза отключена

properties.catalogCollation

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

properties.collation
  • string

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

properties.createMode

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

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

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

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

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

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

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

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

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

properties.creationDate
  • string

Дата создания базы данных (формат ISO8601).

properties.currentBackupStorageRedundancy

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

properties.currentServiceObjectiveName
  • string

Текущее целевое имя уровня обслуживания базы данных.

properties.currentSku

Имя и уровень 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

Тип лицензии для применения к этой базе данных. 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

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

properties.recoverableDatabaseId
  • string

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

properties.recoveryServicesRecoveryPointId
  • string

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

properties.requestedBackupStorageRedundancy

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

properties.requestedServiceObjectiveName
  • string

Запрошенное целевое имя уровня обслуживания базы данных.

properties.restorableDroppedDatabaseId
  • string

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

properties.restorePointInTime
  • string

Указывает точку во времени (формат ISO8601) базы данных-источника, которая будет восстановлена для создания новой базы данных.

properties.resumedDate
  • string

Дата возобновления базы данных действием пользователя или именем входа базы данных (формат ISO8601). Значение NULL, если база данных приостановлена.

properties.sampleName

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

properties.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

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

properties.zoneRedundant
  • boolean

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

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 для ресурса.

Name Type Description
tenantId
  • string

Идентификатор клиента Azure Active Directory.

type

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

userAssignedIdentities

Идентификаторы ресурсов назначенных пользователем удостоверений для использования

DatabaseIdentityType

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

Name Type Description
None
  • string
UserAssigned
  • string

DatabaseLicenseType

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

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

DatabaseListResult

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

Name Type Description
nextLink
  • string

Ссылка для получения следующей страницы результатов.

value

Массив результатов.

DatabaseReadScale

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

Name Type Description
Disabled
  • string
Enabled
  • string

DatabaseStatus

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

Name Type Description
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 для ресурса.

Name Type Description
clientId
  • string

Идентификатор клиента Azure Active Directory.

principalId
  • string

Идентификатор субъекта Azure Active Directory.

SampleName

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

Name Type Description
AdventureWorksLT
  • string
WideWorldImportersFull
  • string
WideWorldImportersStd
  • string

SecondaryType

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

Name Type Description
Geo
  • string
Named
  • string

Sku

SKU ресурса ARM.

Name Type Description
capacity
  • integer

Емкость конкретного номера SKU.

family
  • string

Если служба имеет разные поколения оборудования, то для одного номера SKU это можно записать здесь.

name
  • string

Имя номера SKU, как правило, буква + код номера, например P3.

size
  • string

Размер конкретного номера SKU

tier
  • string

Уровень или выпуск конкретного номера SKU, например "Базовый", "Премиум".