Databases - List By Elastic Pool

Referencia

Servicio:: SQL Database

Versión de la API:: 2021-11-01

Obtiene una lista de bases de datos de un grupo elástico.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
elasticPoolName	path	True	string	Nombre del grupo elástico.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	La versión de API que se usará para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	DatabaseListResult	Recuperó correctamente una lista de bases de datos en un grupo elástico.
Other Status Codes		Respuestas de error: *** 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados. 404 CannotFindObject: no se encuentra el objeto porque no existe o no tiene permisos 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados. 404 ServerNotInSubscription: el servidor especificado no existe en la suscripción especificada. 429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 503 TooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 504 RequestTimeout: la solicitud de servicio superó el tiempo de espera permitido.

Nombre

Tipo

Description

200 OK

DatabaseListResult

Recuperó correctamente una lista de bases de datos en un grupo elástico.

Other Status Codes

Respuestas de error: ***

404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado
404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.
404 CannotFindObject: no se encuentra el objeto porque no existe o no tiene permisos
404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.
404 ServerNotInSubscription: el servidor especificado no existe en la suscripción especificada.
429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar.
429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar.
503 TooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar.
504 RequestTimeout: la solicitud de servicio superó el tiempo de espera permitido.

Ejemplos

Gets a list of databases in an elastic pool.

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


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

Respuesta de muestra

status code:: 200

{
  "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"
    }
  ]
}

Definiciones

Nombre	Description
BackupStorageRedundancy	Tipo de cuenta de almacenamiento que se usa para almacenar copias de seguridad de esta base de datos.
CatalogCollationType	Intercalación del catálogo de metadatos.
CreateMode	Especifica el modo de creación de la base de datos. Valor predeterminado: creación normal de la base de datos. Copiar: crea una base de datos como una copia de una base de datos existente. sourceDatabaseId debe especificarse como identificador de recurso de la base de datos de origen. Secundario: crea una base de datos como una réplica secundaria de una base de datos existente. sourceDatabaseId debe especificarse como el identificador de recurso de la base de datos principal existente. PointInTimeRestore: crea una base de datos restaurando una copia de seguridad a un momento dado de una base de datos existente. sourceDatabaseId debe especificarse como identificador de recurso de la base de datos existente y se debe especificar restorePointInTime. Recuperación: crea una base de datos restaurando una copia de seguridad con replicación geográfica. sourceDatabaseId debe especificarse como identificador de recurso de base de datos recuperable que se va a restaurar. Restaurar: crea una base de datos restaurando una copia de seguridad de una base de datos eliminada. se debe especificar sourceDatabaseId. Si sourceDatabaseId es el identificador de recurso original de la base de datos, se debe especificar sourceDatabaseDeletionDate. De lo contrario, sourceDatabaseId debe ser el identificador de recurso de base de datos quitable restaurable y sourceDatabaseDeletionDate se omite. restorePointInTime también se puede especificar para restaurar desde un momento dado anterior. RestoreLongTermRetentionBackup: crea una base de datos restaurando desde un almacén de retención a largo plazo. recoveryServicesRecoveryPointResourceId debe especificarse como identificador de recurso de punto de recuperación. Copy, Secondary y RestoreLongTermRetentionBackup no se admiten para la edición DataWarehouse.
Database	Un recurso de base de datos.
DatabaseIdentity	Configuración de identidad de Azure Active Directory para un recurso.
DatabaseIdentityType	Tipo de identidad
DatabaseLicenseType	Tipo de licencia que se va a aplicar a esta base de datos. `LicenseIncluded`si necesita una licencia o `BasePrice` si tiene una licencia y es apta para el Ventaja híbrida de Azure.
DatabaseListResult	Una lista de bases de datos.
DatabaseReadScale	Estado del enrutamiento de solo lectura. Si está habilitada, las conexiones que tienen la intención de aplicación establecida en readonly en sus cadena de conexión se pueden enrutar a una réplica secundaria de solo lectura en la misma región. No es aplicable a una base de datos de Hiperescala dentro de un grupo elástico.
DatabaseStatus	Estado de la base de datos.
DatabaseUserIdentity	Configuración de identidad de Azure Active Directory para un recurso.
SampleName	Nombre del esquema de ejemplo que se va a aplicar al crear esta base de datos.
SecondaryType	El tipo secundario de la base de datos si es secundario. Los valores válidos son Geo y Named.
Sku	Una SKU de recursos de ARM.

BackupStorageRedundancy

Tipo de cuenta de almacenamiento que se usa para almacenar copias de seguridad de esta base de datos.

Nombre	Tipo	Description
Geo	string
GeoZone	string
Local	string
Zone	string

CatalogCollationType

Intercalación del catálogo de metadatos.

Nombre	Tipo	Description
DATABASE_DEFAULT	string
SQL_Latin1_General_CP1_CI_AS	string

CreateMode

Especifica el modo de creación de la base de datos.

Valor predeterminado: creación normal de la base de datos.

Copiar: crea una base de datos como una copia de una base de datos existente. sourceDatabaseId debe especificarse como identificador de recurso de la base de datos de origen.

Secundario: crea una base de datos como una réplica secundaria de una base de datos existente. sourceDatabaseId debe especificarse como el identificador de recurso de la base de datos principal existente.

PointInTimeRestore: crea una base de datos restaurando una copia de seguridad a un momento dado de una base de datos existente. sourceDatabaseId debe especificarse como identificador de recurso de la base de datos existente y se debe especificar restorePointInTime.

Recuperación: crea una base de datos restaurando una copia de seguridad con replicación geográfica. sourceDatabaseId debe especificarse como identificador de recurso de base de datos recuperable que se va a restaurar.

Restaurar: crea una base de datos restaurando una copia de seguridad de una base de datos eliminada. se debe especificar sourceDatabaseId. Si sourceDatabaseId es el identificador de recurso original de la base de datos, se debe especificar sourceDatabaseDeletionDate. De lo contrario, sourceDatabaseId debe ser el identificador de recurso de base de datos quitable restaurable y sourceDatabaseDeletionDate se omite. restorePointInTime también se puede especificar para restaurar desde un momento dado anterior.

RestoreLongTermRetentionBackup: crea una base de datos restaurando desde un almacén de retención a largo plazo. recoveryServicesRecoveryPointResourceId debe especificarse como identificador de recurso de punto de recuperación.

Copy, Secondary y RestoreLongTermRetentionBackup no se admiten para la edición DataWarehouse.

Nombre	Tipo	Description
Copy	string
Default	string
OnlineSecondary	string
PointInTimeRestore	string
Recovery	string
Restore	string
RestoreExternalBackup	string
RestoreExternalBackupSecondary	string
RestoreLongTermRetentionBackup	string
Secondary	string

Database

Un recurso de base de datos.

Nombre	Tipo	Description
id	string	Identificador del recurso.
identity	DatabaseIdentity	Identidad de Azure Active Directory de la base de datos.
kind	string	Tipo de base de datos. Estos son los metadatos que se usan para la experiencia de Azure Portal.
location	string	Ubicación del recurso
managedBy	string	Recurso que administra la base de datos.
name	string	Nombre del recurso.
properties.autoPauseDelay	integer	Tiempo en minutos después del cual la base de datos se pausa automáticamente. Un valor de -1 significa que la pausa automática está deshabilitada.
properties.catalogCollation	CatalogCollationType	Intercalación del catálogo de metadatos.
properties.collation	string	Intercalación de la base de datos.
properties.createMode	CreateMode	Especifica el modo de creación de la base de datos. Valor predeterminado: creación normal de la base de datos. Copiar: crea una base de datos como una copia de una base de datos existente. sourceDatabaseId debe especificarse como identificador de recurso de la base de datos de origen. Secundario: crea una base de datos como una réplica secundaria de una base de datos existente. sourceDatabaseId debe especificarse como identificador de recurso de la base de datos principal existente. PointInTimeRestore: crea una base de datos restaurando una copia de seguridad a un momento dado de una base de datos existente. sourceDatabaseId debe especificarse como identificador de recurso de la base de datos existente y se debe especificar restorePointInTime. Recuperación: crea una base de datos restaurando una copia de seguridad con replicación geográfica. sourceDatabaseId debe especificarse como identificador de recurso de base de datos recuperable que se va a restaurar. Restaurar: crea una base de datos restaurando una copia de seguridad de una base de datos eliminada. sourceDatabaseId debe especificarse. Si sourceDatabaseId es el identificador de recurso original de la base de datos, se debe especificar sourceDatabaseDeletionDate. De lo contrario, sourceDatabaseId debe ser el identificador de recurso de base de datos eliminado que se puede restaurar y se omite sourceDatabaseDeletionDate. restorePointInTime también se puede especificar para restaurar desde un momento dado anterior. RestoreLongTermRetentionBackup: crea una base de datos mediante la restauración desde un almacén de retención a largo plazo. recoveryServicesRecoveryPointResourceId debe especificarse como identificador de recurso del punto de recuperación. Copy, Secondary y RestoreLongTermRetentionBackup no se admiten para la edición DataWarehouse.
properties.creationDate	string	Fecha de creación de la base de datos (formato ISO8601).
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Tipo de cuenta de almacenamiento que se usa para almacenar copias de seguridad de esta base de datos.
properties.currentServiceObjectiveName	string	Nombre objetivo de nivel de servicio actual de la base de datos.
properties.currentSku	Sku	Nombre y nivel de la SKU.
properties.databaseId	string	El Id. de la base de datos.
properties.defaultSecondaryLocation	string	Región secundaria predeterminada para esta base de datos.
properties.earliestRestoreDate	string	Esto registra la fecha y hora de inicio más tempranas que la restauración está disponible para esta base de datos (ISO8601 formato).
properties.elasticPoolId	string	Identificador de recursos del grupo elástico que contiene esta base de datos.
properties.failoverGroupId	string	Identificador de recursos del grupo de conmutación por error al que pertenece esta base de datos.
properties.federatedClientId	string	Identificador de cliente usado para el escenario de CMK entre inquilinos por base de datos
properties.highAvailabilityReplicaCount	integer	Número de réplicas secundarias asociadas a la base de datos que se usan para proporcionar alta disponibilidad. No es aplicable a una base de datos de Hiperescala dentro de un grupo elástico.
properties.isInfraEncryptionEnabled	boolean	El cifrado de infraestructura está habilitado para esta base de datos.
properties.isLedgerOn	boolean	Si esta base de datos es o no una base de datos de libro de contabilidad, lo que significa que todas las tablas de la base de datos son tablas de libro de contabilidad. Nota: El valor de esta propiedad no se puede cambiar una vez creada la base de datos.
properties.licenseType	DatabaseLicenseType	Tipo de licencia que se va a aplicar a esta base de datos. `LicenseIncluded`si necesita una licencia o `BasePrice` si tiene una licencia y es apta para la Ventaja híbrida de Azure.
properties.longTermRetentionBackupResourceId	string	Identificador de recursos de la copia de seguridad de retención a largo plazo asociada al funcionamiento de creación de esta base de datos.
properties.maintenanceConfigurationId	string	Identificador de configuración de mantenimiento asignado a la base de datos. Esta configuración define el período en el que se producirán las actualizaciones de mantenimiento.
properties.maxLogSizeBytes	integer	Tamaño máximo del registro de esta base de datos.
properties.maxSizeBytes	integer	Tamaño máximo de la base de datos expresada en bytes.
properties.minCapacity	number	Capacidad mínima que la base de datos siempre tendrá asignada, si no está en pausa
properties.pausedDate	string	La fecha en que la base de datos se ha pausado mediante la configuración del usuario o la acción (ISO8601 formato). Null si la base de datos está lista.
properties.readScale	DatabaseReadScale	Estado del enrutamiento de solo lectura. Si está habilitada, las conexiones que tienen intención de aplicación establecida en readonly en sus cadena de conexión se pueden enrutar a una réplica secundaria de solo lectura en la misma región. No es aplicable a una base de datos de Hiperescala dentro de un grupo elástico.
properties.recoverableDatabaseId	string	Identificador de recurso de la base de datos recuperable asociada a la operación de creación de esta base de datos.
properties.recoveryServicesRecoveryPointId	string	Identificador de recurso del punto de recuperación asociado a la operación de creación de esta base de datos.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Tipo de cuenta de almacenamiento que se va a usar para almacenar copias de seguridad de esta base de datos.
properties.requestedServiceObjectiveName	string	Nombre objetivo de nivel de servicio solicitado de la base de datos.
properties.restorableDroppedDatabaseId	string	Identificador de recurso de la base de datos eliminada restaurable asociada con la operación de creación de esta base de datos.
properties.restorePointInTime	string	Especifica el momento dado (ISO8601 formato) de la base de datos de origen que se restaurará para crear la nueva base de datos.
properties.resumedDate	string	Fecha en la que la acción del usuario reanudó la base de datos o el inicio de sesión de la base de datos (ISO8601 formato). Null si la base de datos está en pausa.
properties.sampleName	SampleName	Nombre del esquema de ejemplo que se va a aplicar al crear esta base de datos.
properties.secondaryType	SecondaryType	El tipo secundario de la base de datos si es secundario. Los valores válidos son Geo y Named.
properties.sourceDatabaseDeletionDate	string	Especifica la hora en que se eliminó la base de datos.
properties.sourceDatabaseId	string	Identificador de recurso de la base de datos de origen asociada a la operación de creación de esta base de datos.
properties.sourceResourceId	string	Identificador de recurso del origen asociado a la operación de creación de esta base de datos. Esta propiedad solo se admite para la edición DataWarehouse y permite restaurar entre suscripciones. Cuando se especifica sourceResourceId, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId y sourceDatabaseDeletionDate no deben especificarse y CreateMode debe ser PointInTimeRestore, Restore o Recover. Cuando createMode es PointInTimeRestore, sourceResourceId debe ser el identificador de recurso de la base de datos existente o el grupo de sql existente y se debe especificar restorePointInTime. Cuando createMode es Restore, sourceResourceId debe ser el identificador de recurso de la base de datos quitada restaurable o el grupo de sql quitado restaurable. Cuando createMode es Recover, sourceResourceId debe ser el identificador de recurso de la base de datos recuperable o el grupo de sql recuperable. Cuando la suscripción de origen pertenece a un inquilino diferente al de la suscripción de destino, el encabezado "x-ms-authorization-auxiliary" debe contener el token de autenticación para el inquilino de origen. Para obtener más información sobre el encabezado "x-ms-authorization-auxiliary", consulte https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
properties.status	DatabaseStatus	Estado de la base de datos.
properties.zoneRedundant	boolean	Si esta base de datos tiene redundancia de zona o no, lo que significa que las réplicas de esta base de datos se distribuirán entre varias zonas de disponibilidad.
sku	Sku	SKU de base de datos. La lista de SKU puede variar según la región y la oferta de soporte técnico. Para determinar las SKU (incluido el nombre de la SKU, la edición, la familia y la capacidad) que están disponibles para la suscripción en una región de Azure, use la `Capabilities_ListByLocation` API REST o uno de los siguientes comandos: `az sql db list-editions -l <location> -o table` `Get-AzSqlServerServiceObjective -Location <location>`
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso.

DatabaseIdentity

Configuración de identidad de Azure Active Directory para un recurso.

Nombre	Tipo	Description
tenantId	string	Identificador de inquilino de Azure Active Directory.
type	DatabaseIdentityType	Tipo de identidad
userAssignedIdentities	<string, DatabaseUserIdentity>	Identificadores de recurso de las identidades asignadas por el usuario que se van a usar

DatabaseIdentityType

Tipo de identidad

Nombre	Tipo	Description
None	string
UserAssigned	string

DatabaseLicenseType

Tipo de licencia que se va a aplicar a esta base de datos. LicenseIncludedsi necesita una licencia o BasePrice si tiene una licencia y es apta para el Ventaja híbrida de Azure.

Nombre	Tipo	Description
BasePrice	string
LicenseIncluded	string

DatabaseListResult

Una lista de bases de datos.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la página siguiente de resultados.
value	Database[]	Matriz de resultados.

DatabaseReadScale

Estado del enrutamiento de solo lectura. Si está habilitada, las conexiones que tienen la intención de aplicación establecida en readonly en sus cadena de conexión se pueden enrutar a una réplica secundaria de solo lectura en la misma región. No es aplicable a una base de datos de Hiperescala dentro de un grupo elástico.

Nombre	Tipo	Description
Disabled	string
Enabled	string

DatabaseStatus

Estado de la base de datos.

Nombre	Tipo	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

Configuración de identidad de Azure Active Directory para un recurso.

Nombre	Tipo	Description
clientId	string	Identificador de cliente de Azure Active Directory.
principalId	string	Identificador de entidad de seguridad de Azure Active Directory.

SampleName

Nombre del esquema de ejemplo que se va a aplicar al crear esta base de datos.

Nombre	Tipo	Description
AdventureWorksLT	string
WideWorldImportersFull	string
WideWorldImportersStd	string

SecondaryType

El tipo secundario de la base de datos si es secundario. Los valores válidos son Geo y Named.

Nombre	Tipo	Description
Geo	string
Named	string

Sku

Una SKU de recursos de ARM.

Nombre	Tipo	Description
capacity	integer	Capacidad de la SKU determinada.
family	string	Si el servicio tiene diferentes generaciones de hardware, para la misma SKU, se puede capturar aquí.
name	string	El nombre de la SKU, normalmente, una letra + código numérico, por ejemplo, P3.
size	string	Tamaño de la SKU determinada
tier	string	El nivel o la edición de la SKU determinada, por ejemplo, Básico, Premium.

Compartir a través de

Databases - List By Elastic Pool

Parámetros de identificador URI

Respuestas

Ejemplos

Gets a list of databases in an elastic pool.

Solicitud de ejemplo

Respuesta de muestra

Definiciones

BackupStorageRedundancy

CatalogCollationType

CreateMode

Database

DatabaseIdentity

DatabaseIdentityType

DatabaseLicenseType

DatabaseListResult

DatabaseReadScale

DatabaseStatus

DatabaseUserIdentity

SampleName

SecondaryType

Sku

Recursos adicionales