你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Databases - Get

获取数据库。

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

URI 参数

名称 必需 类型 说明
databaseName
path True

string

要检索的数据库的名称。

resourceGroupName
path True

string

包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。

serverName
path True

string

服务器的名称。

subscriptionId
path True

string

标识 Azure 订阅的订阅 ID。

api-version
query True

string

要用于请求的 API 版本。

$expand
query

string

在响应中展开的子对象的逗号分隔列表。 可能的属性:serviceTierAdvisors、transparentDataEncryption。

响应

名称 类型 说明
200 OK

Database

还行

示例

Get a database

示例请求

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-9187?api-version=2014-04-01

示例响应

{
  "tags": {
    "tagKey1": "TagValue1"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-9187",
  "name": "sqlcrudtest-9187",
  "type": "Microsoft.Sql/servers/databases",
  "location": "Japan East",
  "kind": "v12.0,user",
  "properties": {
    "databaseId": "200216b2-dc19-4866-85aa-f73fe4a1ebac",
    "edition": "Basic",
    "status": "Online",
    "serviceLevelObjective": "Basic",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": "2147483648",
    "creationDate": "2017-02-10T00:56:19.2Z",
    "currentServiceObjectiveId": "dd6d99bb-f193-4ec1-86f2-43d3bccbc49c",
    "requestedServiceObjectiveId": "dd6d99bb-f193-4ec1-86f2-43d3bccbc49c",
    "requestedServiceObjectiveName": "Basic",
    "sampleName": null,
    "defaultSecondaryLocation": "Japan West",
    "earliestRestoreDate": "2017-02-10T01:06:29.78Z",
    "elasticPoolName": null,
    "containmentState": 2,
    "readScale": "Disabled",
    "failoverGroupId": null
  }
}

定义

名称 说明
CreateMode

指定数据库创建模式。

默认值:常规数据库创建。

复制:将数据库创建为现有数据库的副本。 sourceDatabaseId 必须指定为源数据库的资源 ID。

OnlineSecondary/NonReadableSecondary:将数据库创建为现有数据库的辅助副本(可读或不可读)。 sourceDatabaseId 必须指定为现有主数据库的资源 ID。

PointInTimeRestore:通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID,并且必须指定 restorePointInTime。

恢复:通过还原异地复制的备份来创建数据库。 sourceDatabaseId 必须指定为可恢复的数据库资源 ID 才能还原。

还原:通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID,则必须指定 sourceDatabaseDeletionDate。 否则,sourceDatabaseId 必须是可还原删除的数据库资源 ID,并且将忽略 sourceDatabaseDeletionDate。 还可以指定 restorePointInTime,以便从以前的时间点还原。

RestoreLongTermRetentionBackup:通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。

DataWarehouse 版本不支持 Copy、NonReadableSecondary、OnlineSecondary 和 RestoreLongTermRetentionBackup。

Database

表示数据库。

DatabaseEdition

数据库的版本。 DatabaseEditions 枚举包含所有有效版本。 如果 createMode 为 NonReadableSecondary 或 OnlineSecondary,则忽略此值。

SKU 列表可能因区域和支持产品/服务而异。 若要确定 Azure 区域中订阅可用的 SKU(包括 SKU 名称、层/版本、系列和容量),请使用 Capabilities_ListByLocation REST API 或以下命令之一:

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

执行建议索引作的估计影响。

ReadScale

有條件的。 如果数据库是异地辅助数据库,readScale 指示是否允许与此数据库建立只读连接。 DataWarehouse 版本不支持。

RecommendedIndex

此数据库的建议索引。

RecommendedIndexAction

建议的索引作。 可以创建缺失的索引、删除未使用的索引或重新生成现有索引以提高其性能。

RecommendedIndexState

当前建议状态。

RecommendedIndexType

索引的类型(CLUSTERED、NONCLUSTERED、COLUMNSTORE、CLUSTERED COLUMNSTORE)

SampleName

指示创建此数据库时要应用的示例架构的名称。 如果 createMode 不是默认值,则忽略此值。 DataWarehouse 版本不支持。

ServiceObjectiveName

数据库配置的服务级别目标的名称。 这是正在应用于数据库的服务级别目标。 成功更新后,它将匹配 serviceLevelObjective 属性的值。

SKU 列表可能因区域和支持产品/服务而异。 若要确定 Azure 区域中订阅可用的 SKU(包括 SKU 名称、层/版本、系列和容量),请使用 Capabilities_ListByLocation REST API 或以下命令之一:

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

此数据库的服务层顾问列表。 展开的属性

SloUsageMetric

获取或设置服务层顾问的 serviceLevelObjectiveUsageMetrics。

TransparentDataEncryption

此数据库的透明数据加密信息。

TransparentDataEncryptionStatus

数据库透明数据加密的状态。

CreateMode

指定数据库创建模式。

默认值:常规数据库创建。

复制:将数据库创建为现有数据库的副本。 sourceDatabaseId 必须指定为源数据库的资源 ID。

OnlineSecondary/NonReadableSecondary:将数据库创建为现有数据库的辅助副本(可读或不可读)。 sourceDatabaseId 必须指定为现有主数据库的资源 ID。

PointInTimeRestore:通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID,并且必须指定 restorePointInTime。

恢复:通过还原异地复制的备份来创建数据库。 sourceDatabaseId 必须指定为可恢复的数据库资源 ID 才能还原。

还原:通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID,则必须指定 sourceDatabaseDeletionDate。 否则,sourceDatabaseId 必须是可还原删除的数据库资源 ID,并且将忽略 sourceDatabaseDeletionDate。 还可以指定 restorePointInTime,以便从以前的时间点还原。

RestoreLongTermRetentionBackup:通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。

DataWarehouse 版本不支持 Copy、NonReadableSecondary、OnlineSecondary 和 RestoreLongTermRetentionBackup。

说明
Copy
Default
NonReadableSecondary
OnlineSecondary
PointInTimeRestore
Recovery
Restore
RestoreLongTermRetentionBackup

Database

表示数据库。

名称 类型 说明
id

string

资源 ID。

kind

string

数据库类型。 这是用于 Azure 门户体验的元数据。

location

string

资源位置。

name

string

资源名称。

properties.collation

string

数据库的排序规则。 如果 createMode 不是默认值,则忽略此值。

properties.containmentState

integer (int64)

数据库的包含状态。

properties.createMode

CreateMode

指定数据库创建模式。

默认值:常规数据库创建。

复制:将数据库创建为现有数据库的副本。 sourceDatabaseId 必须指定为源数据库的资源 ID。

OnlineSecondary/NonReadableSecondary:将数据库创建为现有数据库的辅助副本(可读或不可读)。 sourceDatabaseId 必须指定为现有主数据库的资源 ID。

PointInTimeRestore:通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID,并且必须指定 restorePointInTime。

恢复:通过还原异地复制的备份来创建数据库。 sourceDatabaseId 必须指定为可恢复的数据库资源 ID 才能还原。

还原:通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID,则必须指定 sourceDatabaseDeletionDate。 否则,sourceDatabaseId 必须是可还原删除的数据库资源 ID,并且将忽略 sourceDatabaseDeletionDate。 还可以指定 restorePointInTime,以便从以前的时间点还原。

RestoreLongTermRetentionBackup:通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。

DataWarehouse 版本不支持 Copy、NonReadableSecondary、OnlineSecondary 和 RestoreLongTermRetentionBackup。

properties.creationDate

string (date-time)

数据库的创建日期(ISO8601格式)。

properties.currentServiceObjectiveId

string (uuid)

数据库的当前服务级别目标 ID。 这是当前处于活动状态的服务级别目标的 ID。

properties.databaseId

string (uuid)

数据库的 ID。

properties.defaultSecondaryLocation

string

此数据库的默认次要区域。

properties.earliestRestoreDate

string (date-time)

这会记录此数据库的最早开始日期和时间(ISO8601格式)。

properties.edition

DatabaseEdition

数据库的版本。 DatabaseEditions 枚举包含所有有效版本。 如果 createMode 为 NonReadableSecondary 或 OnlineSecondary,则忽略此值。

SKU 列表可能因区域和支持产品/服务而异。 若要确定 Azure 区域中订阅可用的 SKU(包括 SKU 名称、层/版本、系列和容量),请使用 Capabilities_ListByLocation REST API 或以下命令之一:

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
properties.elasticPoolName

string

数据库位于的弹性池的名称。 如果 elasticPoolName 和 requestedServiceObjectiveName 均已更新,则忽略 requestedServiceObjectiveName 的值。 DataWarehouse 版本不支持。

properties.failoverGroupId

string

包含此数据库的故障转移组的资源标识符。

properties.maxSizeBytes

string

以字节表示的数据库的最大大小。 如果 createMode 不是默认值,则忽略此值。 若要查看可能的值,请查询 operationId 引用的功能 API(/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities):“Capabilities_ListByLocation”。

properties.readScale

ReadScale

有條件的。 如果数据库是异地辅助数据库,readScale 指示是否允许与此数据库建立只读连接。 DataWarehouse 版本不支持。

properties.recommendedIndex

RecommendedIndex[]

此数据库的建议索引。

properties.recoveryServicesRecoveryPointResourceId

string

有條件的。 如果 createMode 为 RestoreLongTermRetentionBackup,则此值是必需的。 指定要从中还原的恢复点的资源 ID。

properties.requestedServiceObjectiveId

string (uuid)

数据库的已配置服务级别目标 ID。 这是正在应用于数据库的服务级别目标。 成功更新后,它将匹配 currentServiceObjectiveId 属性的值。 如果同时更新 requestedServiceObjectiveId 和 requestedServiceObjectiveName,则 requestedServiceObjectiveId 的值将替代 requestedServiceObjectiveName 的值。

SKU 列表可能因区域和支持产品/服务而异。 若要确定 Azure 区域中订阅可用的服务目标 ID,请使用 Capabilities_ListByLocation REST API。

properties.requestedServiceObjectiveName

ServiceObjectiveName

数据库配置的服务级别目标的名称。 这是正在应用于数据库的服务级别目标。 成功更新后,它将匹配 serviceLevelObjective 属性的值。

SKU 列表可能因区域和支持产品/服务而异。 若要确定 Azure 区域中订阅可用的 SKU(包括 SKU 名称、层/版本、系列和容量),请使用 Capabilities_ListByLocation REST API 或以下命令之一:

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
properties.restorePointInTime

string (date-time)

有條件的。 如果 createMode 为 PointInTimeRestore,则此值是必需的。 如果 createMode 为 Restore,则此值是可选的。 指定将还原以创建新数据库的源数据库的时间点(ISO8601格式)。 必须大于或等于源数据库的最早RestoreDate 值。

properties.sampleName

SampleName

指示创建此数据库时要应用的示例架构的名称。 如果 createMode 不是默认值,则忽略此值。 DataWarehouse 版本不支持。

properties.serviceLevelObjective

ServiceObjectiveName

数据库的当前服务级别目标。

properties.serviceTierAdvisors

ServiceTierAdvisor[]

此数据库的服务层顾问列表。 展开的属性

properties.sourceDatabaseDeletionDate

string (date-time)

有條件的。 如果 createMode 为 Restore,并且 sourceDatabaseId 是已删除的数据库的原始资源 ID(而不是其当前可还原的已删除数据库 ID),则此值是必需的。 指定删除数据库的时间。

properties.sourceDatabaseId

string

有條件的。 如果 createMode 为 Copy、NonReadableSecondary、OnlineSecondary、PointInTimeRestore、Recovery 或 Restore,则此值是必需的。 指定源数据库的资源 ID。 如果 createMode 为 NonReadableSecondary 或 OnlineSecondary,则源数据库的名称必须与要创建新数据库的名称相同。

properties.status

string

数据库的状态。

properties.transparentDataEncryption

TransparentDataEncryption[]

此数据库的透明数据加密信息。

properties.zoneRedundant

boolean

此数据库是否为区域冗余,这意味着此数据库的副本将分布在多个可用性区域。

tags

object

资源标记。

type

string

资源类型。

DatabaseEdition

数据库的版本。 DatabaseEditions 枚举包含所有有效版本。 如果 createMode 为 NonReadableSecondary 或 OnlineSecondary,则忽略此值。

SKU 列表可能因区域和支持产品/服务而异。 若要确定 Azure 区域中订阅可用的 SKU(包括 SKU 名称、层/版本、系列和容量),请使用 Capabilities_ListByLocation REST API 或以下命令之一:

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
说明
Basic
Business
BusinessCritical
DataWarehouse
Free
GeneralPurpose
Hyperscale
Premium
PremiumRS
Standard
Stretch
System
System2
Web

OperationImpact

执行建议索引作的估计影响。

名称 类型 说明
changeValueAbsolute

number (double)

对维度的绝对影响。

changeValueRelative

number (double)

维度的相对影响(如果不适用)

name

string

影响维度的名称。

unit

string

测量对维度的估计影响单位。

ReadScale

有條件的。 如果数据库是异地辅助数据库,readScale 指示是否允许与此数据库建立只读连接。 DataWarehouse 版本不支持。

说明
Disabled
Enabled

RecommendedIndex

此数据库的建议索引。

名称 类型 说明
id

string

资源 ID。

name

string

资源名称。

properties.action

RecommendedIndexAction

建议的索引作。 可以创建缺失的索引、删除未使用的索引或重新生成现有索引以提高其性能。

properties.columns

string[]

要在其中生成索引的列

properties.created

string (date-time)

显示创建此资源的 UTC 日期/时间(ISO8601格式)。

properties.estimatedImpact

OperationImpact[]

执行建议索引作的估计影响。

properties.includedColumns

string[]

要包含在索引中的列名列表

properties.indexScript

string

完整的生成索引脚本

properties.indexType

RecommendedIndexType

索引的类型(CLUSTERED、NONCLUSTERED、COLUMNSTORE、CLUSTERED COLUMNSTORE)

properties.lastModified

string (date-time)

上次更改此资源的 UTC 日期/时间(ISO8601格式)。

properties.reportedImpact

OperationImpact[]

索引作完成后报告的值。

properties.schema

string

表在其上生成索引的架构

properties.state

RecommendedIndexState

当前建议状态。

properties.table

string

要在其中生成索引的表。

type

string

资源类型。

RecommendedIndexAction

建议的索引作。 可以创建缺失的索引、删除未使用的索引或重新生成现有索引以提高其性能。

说明
Create
Drop
Rebuild

RecommendedIndexState

当前建议状态。

说明
Active
Blocked
Executing
Expired
Ignored
Pending
Pending Revert
Reverted
Reverting
Success
Verifying

RecommendedIndexType

索引的类型(CLUSTERED、NONCLUSTERED、COLUMNSTORE、CLUSTERED COLUMNSTORE)

说明
CLUSTERED
CLUSTERED COLUMNSTORE
COLUMNSTORE
NONCLUSTERED

SampleName

指示创建此数据库时要应用的示例架构的名称。 如果 createMode 不是默认值,则忽略此值。 DataWarehouse 版本不支持。

说明
AdventureWorksLT

ServiceObjectiveName

数据库配置的服务级别目标的名称。 这是正在应用于数据库的服务级别目标。 成功更新后,它将匹配 serviceLevelObjective 属性的值。

SKU 列表可能因区域和支持产品/服务而异。 若要确定 Azure 区域中订阅可用的 SKU(包括 SKU 名称、层/版本、系列和容量),请使用 Capabilities_ListByLocation REST API 或以下命令之一:

az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
说明
Basic
DS100
DS1000
DS1200
DS1500
DS200
DS2000
DS300
DS400
DS500
DS600
DW100
DW1000
DW10000c
DW1000c
DW1200
DW1500
DW15000c
DW1500c
DW200
DW2000
DW2000c
DW2500c
DW300
DW3000
DW30000c
DW3000c
DW400
DW500
DW5000c
DW600
DW6000
DW6000c
DW7500c
ElasticPool
Free
P1
P11
P15
P2
P3
P4
P6
PRS1
PRS2
PRS4
PRS6
S0
S1
S12
S2
S3
S4
S6
S7
S9
System
System0
System1
System2
System2L
System3
System3L
System4
System4L

ServiceTierAdvisor

此数据库的服务层顾问列表。 展开的属性

名称 类型 说明
id

string

资源 ID。

name

string

资源名称。

properties.activeTimeRatio

number (double)

适用于服务层顾问的 activeTimeRatio。

properties.avgDtu

number (double)

获取或设置服务层顾问的 avgDtu。

properties.confidence

number (double)

获取或设置服务层顾问的置信度。

properties.currentServiceLevelObjective

string

获取或设置服务层顾问的 currentServiceLevelObjective。

properties.currentServiceLevelObjectiveId

string (uuid)

获取或设置服务层顾问的 currentServiceLevelObjectiveId。

properties.databaseSizeBasedRecommendationServiceLevelObjective

string

获取或设置服务层顾问的 databaseSizeBasedRecommendationServiceLevelObjective。

properties.databaseSizeBasedRecommendationServiceLevelObjectiveId

string (uuid)

获取或设置服务层顾问的 databaseSizeBasedRecommendationServiceLevelObjectiveId。

properties.disasterPlanBasedRecommendationServiceLevelObjective

string

获取或设置 service tier advisor 的 disasterPlanBasedRecommendationServiceLevelObjective。

properties.disasterPlanBasedRecommendationServiceLevelObjectiveId

string (uuid)

获取或设置 service tier advisor 的 disasterPlanBasedRecommendationServiceLevelObjectiveId。

properties.maxDtu

number (double)

获取或设置服务层顾问的 maxDtu。

properties.maxSizeInGB

number (double)

获取或设置服务层顾问的 maxSizeInGB。

properties.minDtu

number (double)

获取或设置服务层顾问的 minDtu。

properties.observationPeriodEnd

string (date-time)

观察期开始(ISO8601格式)。

properties.observationPeriodStart

string (date-time)

观察期开始(ISO8601格式)。

properties.overallRecommendationServiceLevelObjective

string

获取或设置服务层顾问的 overallRecommendationServiceLevelObjective。

properties.overallRecommendationServiceLevelObjectiveId

string (uuid)

获取或设置服务层顾问的 overallRecommendationServiceLevelObjectiveId。

properties.serviceLevelObjectiveUsageMetrics

SloUsageMetric[]

获取或设置服务层顾问的 serviceLevelObjectiveUsageMetrics。

properties.usageBasedRecommendationServiceLevelObjective

string

获取或设置服务层顾问的 usageBasedRecommendationServiceLevelObjective。

properties.usageBasedRecommendationServiceLevelObjectiveId

string (uuid)

获取或设置 service tier 顾问的 usageBasedRecommendationServiceLevelObjectiveId。

type

string

资源类型。

SloUsageMetric

获取或设置服务层顾问的 serviceLevelObjectiveUsageMetrics。

名称 类型 说明
inRangeTimeRatio

number (double)

获取或设置 SLO 使用情况指标的 inRangeTimeRatio。

serviceLevelObjective

ServiceObjectiveName

SLO 使用情况指标的 serviceLevelObjective。

serviceLevelObjectiveId

string (uuid)

SLO 使用情况指标的 serviceLevelObjectiveId。

TransparentDataEncryption

此数据库的透明数据加密信息。

名称 类型 说明
id

string

资源 ID。

location

string

资源位置。

name

string

资源名称。

properties.status

TransparentDataEncryptionStatus

数据库透明数据加密的状态。

type

string

资源类型。

TransparentDataEncryptionStatus

数据库透明数据加密的状态。

说明
Disabled
Enabled