Compartir a través de


Databases - Get

Obtiene una base de datos.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
databaseName
path True

string

Nombre de la base de datos.

resourceGroupName
path True

string

Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.

serverName
path True

string

Nombre del servidor.

subscriptionId
path True

string

Identificador de suscripción que identifica una suscripción de Azure.

api-version
query True

string

Versión de la API que se va a usar para la solicitud.

$expand
query

string

Los recursos secundarios que se van a incluir en la respuesta.

$filter
query

string

Expresión de filtro de OData que filtra los elementos de la colección.

Respuestas

Nombre Tipo Description
200 OK

Database

Recuperó correctamente la base de datos especificada.

Other Status Codes

ErrorResponse

Respuestas de error: ***

  • 400 ManagedInstanceStoppingOrStopped: operación en conflicto enviada mientras la instancia está en estado de detención o detención

  • 400 ManagedInstanceStarting: operación en conflicto enviada mientras la instancia está en estado de inicio

  • 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.

  • 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado.

  • 404 ResourceNotFound: no se encontró el recurso solicitado.

Ejemplos

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.

Solicitud de ejemplo

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

Respuesta de muestra

{
  "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.

Solicitud de ejemplo

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

Respuesta de muestra

{
  "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.

Solicitud de ejemplo

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

Respuesta de muestra

{
  "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.

Solicitud de ejemplo

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

Respuesta de muestra

{
  "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.

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
AlwaysEncryptedEnclaveType

Tipo de enclave solicitado en la base de datos, es decir, enclaves predeterminados o VBS.

AvailabilityZoneType

Especifica la zona de disponibilidad a la que está anclada la base de datos.

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 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 descartable 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

DatabaseKey

Clave de nivel de base de datos usada para el cifrado en reposo.

DatabaseKeyType

Tipo de clave de base de datos. Solo el valor admitido es "AzureKeyVault".

DatabaseLicenseType

Tipo de licencia que se va a solicitar para 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.

DatabaseReadScale

Estado del enrutamiento de solo lectura. Si está habilitada, las conexiones que tienen intención de aplicación establecida en readonly en su 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.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

FreeLimitExhaustionBehavior

Especifica el comportamiento cuando se agotan los límites gratuitos mensuales para la base de datos gratuita.

AutoPause: la base de datos se pausará automáticamente tras el agotamiento de los límites libres durante el resto del mes.

BillForUsage: la base de datos seguirá estando en línea tras el agotamiento de los límites gratuitos y se facturará cualquier uso por encima del límite.

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, Named y Standby.

Sku

Una SKU de recursos de ARM.

AlwaysEncryptedEnclaveType

Tipo de enclave solicitado en la base de datos, es decir, enclaves predeterminados o VBS.

Valor Description
Default
VBS

AvailabilityZoneType

Especifica la zona de disponibilidad a la que está anclada la base de datos.

Valor Description
1
2
3
NoPreference

BackupStorageRedundancy

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

Valor Description
Geo
GeoZone
Local
Zone

CatalogCollationType

Intercalación del catálogo de metadatos.

Valor Description
DATABASE_DEFAULT
SQL_Latin1_General_CP1_CI_AS

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

Valor Description
Copy
Default
OnlineSecondary
PointInTimeRestore
Recovery
Restore
RestoreExternalBackup
RestoreExternalBackupSecondary
RestoreLongTermRetentionBackup
Secondary

Database

Un recurso de base de datos.

Nombre Tipo Description
id

string

Identificador de 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 (int32)

Hora en minutos después de la cual la base de datos se pausa automáticamente. Un valor de -1 significa que la pausa automática está deshabilitada

properties.availabilityZone

AvailabilityZoneType

Especifica la zona de disponibilidad a la que está anclada la base de datos.

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

properties.creationDate

string (date-time)

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 (uuid)

Identificador de la base de datos.

properties.defaultSecondaryLocation

string

Región secundaria predeterminada para esta base de datos.

properties.earliestRestoreDate

string (date-time)

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 (arm-id)

Identificador de recurso del grupo elástico que contiene esta base de datos.

properties.encryptionProtector

string

El URI de Azure Key Vault de la base de datos si está configurado con claves administradas por cliente de base de datos.

properties.encryptionProtectorAutoRotation

boolean

Marca para habilitar o deshabilitar la rotación automática de la clave AKV del protector de cifrado de 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 (uuid)

Identificador de cliente usado para el escenario entre inquilinos por base de datos de CMK

properties.freeLimitExhaustionBehavior

FreeLimitExhaustionBehavior

Especifica el comportamiento cuando se agotan los límites gratuitos mensuales para la base de datos gratuita.

AutoPause: la base de datos se pausará automáticamente tras el agotamiento de los límites libres durante el resto del mes.

BillForUsage: la base de datos seguirá estando en línea tras el agotamiento de los límites gratuitos y se facturará cualquier uso por encima del límite.

properties.highAvailabilityReplicaCount

integer (int32)

Número de réplicas secundarias asociadas a la base de datos crítico para la empresa, Premium o Hiperescala 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 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 después de crear la base de datos.

properties.keys

<string,  DatabaseKey>

Identificadores de recursos de las identidades asignadas por el usuario que se van a usar

properties.licenseType

DatabaseLicenseType

Tipo de licencia que se va a solicitar para 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 (arm-id)

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

boolean

Si es necesario realizar la migración manual controlada por el cliente durante la operación actualizar base de datos al nivel hiperescala.

Esta propiedad solo es aplicable al escalado de la base de datos de nivel Crítico para la empresa, Uso general, Premium o Estándar a Nivel hiperescala.

Cuando se especifica manualCutover, la operación de escalado esperará a que la entrada del usuario desencadene la migración a la base de datos de Hiperescala.

Para desencadenar la transición, proporcione el parámetro "performCutover" cuando la operación de escalado esté en estado En espera.

properties.maxLogSizeBytes

integer (int64)

Tamaño máximo del registro de esta base de datos.

properties.maxSizeBytes

integer (int64)

Tamaño máximo de la base de datos expresada en bytes.

properties.minCapacity

number (double)

Capacidad mínima que la base de datos siempre tendrá asignada, si no está en pausa

properties.pausedDate

string (date-time)

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

boolean

Para desencadenar la migración manual controlada por el cliente durante el estado de espera mientras la operación de escalado está en curso.

Este parámetro de propiedad solo es aplicable a las operaciones de escalado que se inician junto con el parámetro "manualCutover".

Esta propiedad solo es aplicable cuando el escalado de la base de datos de nivel Crítico para la empresa, Uso general, Premium o Estándar a Nivel hiperescala ya está en curso.

Cuando se especifica performCutover, la operación de escalado desencadenará la transición y realizará el cambio de rol en la base de datos de Hiperescala.

properties.preferredEnclaveType

AlwaysEncryptedEnclaveType

Tipo de enclave solicitado en la base de datos, es decir, enclaves predeterminados o VBS.

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 su 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 (arm-id)

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 (arm-id)

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 (arm-id)

Identificador de recurso de la base de datos que se puede restaurar asociada a la operación de creación de esta base de datos.

properties.restorePointInTime

string (date-time)

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 (date-time)

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, Named y Standby.

properties.sourceDatabaseDeletionDate

string (date-time)

Especifica la hora en que se eliminó la base de datos.

properties.sourceDatabaseId

string (arm-id)

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 (arm-id)

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

boolean

Si la base de datos usa o no límites mensuales gratuitos. Se permite en una base de datos de una suscripción.

properties.zoneRedundant

boolean

Si esta base de datos es con redundancia de zona, 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 API REST de Capabilities_ListByLocation o uno de los siguientes comandos:

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
tags

object

Etiquetas de recursos.

type

string

Tipo de recurso.

DatabaseIdentity

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

Nombre Tipo Description
tenantId

string (uuid)

Identificador de inquilino de Azure Active Directory.

type

DatabaseIdentityType

Tipo de identidad

userAssignedIdentities

<string,  DatabaseUserIdentity>

Identificadores de recursos de las identidades asignadas por el usuario que se van a usar

DatabaseIdentityType

Tipo de identidad

Valor Description
None
UserAssigned

DatabaseKey

Clave de nivel de base de datos usada para el cifrado en reposo.

Nombre Tipo Description
creationDate

string (date-time)

Fecha de creación de la clave de base de datos.

subregion

string

Subdivisión de la clave de servidor.

thumbprint

string

Huella digital de la clave de base de datos.

type

DatabaseKeyType

Tipo de clave de base de datos. Solo el valor admitido es "AzureKeyVault".

DatabaseKeyType

Tipo de clave de base de datos. Solo el valor admitido es "AzureKeyVault".

Valor Description
AzureKeyVault

DatabaseLicenseType

Tipo de licencia que se va a solicitar para 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.

Valor Description
BasePrice
LicenseIncluded

DatabaseReadScale

Estado del enrutamiento de solo lectura. Si está habilitada, las conexiones que tienen intención de aplicación establecida en readonly en su 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.

Valor Description
Disabled
Enabled

DatabaseStatus

Estado de la base de datos.

Valor Description
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

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

Nombre Tipo Description
clientId

string (uuid)

Identificador de cliente de Azure Active Directory.

principalId

string (uuid)

Identificador de entidad de seguridad de Azure Active Directory.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.

type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Detalles del error.

message

string

Mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

FreeLimitExhaustionBehavior

Especifica el comportamiento cuando se agotan los límites gratuitos mensuales para la base de datos gratuita.

AutoPause: la base de datos se pausará automáticamente tras el agotamiento de los límites libres durante el resto del mes.

BillForUsage: la base de datos seguirá estando en línea tras el agotamiento de los límites gratuitos y se facturará cualquier uso por encima del límite.

Valor Description
AutoPause
BillOverUsage

SampleName

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

Valor Description
AdventureWorksLT
WideWorldImportersFull
WideWorldImportersStd

SecondaryType

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

Valor Description
Geo
Named
Standby

Sku

Una SKU de recursos de ARM.

Nombre Tipo Description
capacity

integer (int32)

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 de número, por ejemplo, P3.

size

string

Tamaño de la SKU determinada

tier

string

Nivel o edición de la SKU concreta, por ejemplo, Básico, Premium.