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

Encryption Protectors - List By Server

服务:

SQL Database

API 版本:

2023-08-01

获取服务器加密保护程序的列表

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
serverName	path	True	string	服务器的名称。
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。

响应

名称	类型	说明
200 OK	EncryptionProtectorListResult	已成功检索服务器加密保护程序列表。
Other Status Codes	ErrorResponse	错误响应： *** 400 ManagedInstanceStoppingOrStopped - 实例处于停止/停止状态时提交的冲突作 400 ManagedInstanceStarting - 实例处于启动状态时提交的冲突作 400 InvalidKeyName - 为服务器密钥名称提供了无效值。 400 InvalidKeyType - 不支持创建服务器密钥类型。 400 InvalidUpsertKeyType - 服务管理的 TDE 密钥由服务管理。 服务管理的 TDE 密钥不支持用户创建或更新。 400 InvalidKeyUpsertRequest - 创建服务器密钥请求不存在或没有属性对象。 400 InvalidEncryptionProtectorName - 不支持加密保护程序密钥名称。 404 ServerNotInSubscriptionResourceGroup - 指定的服务器在指定的资源组和订阅中不存在。 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器

示例

List encryption protectors by server

示例请求

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector?api-version=2023-08-01

示例响应

状态代码:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current",
      "name": "current",
      "type": "Microsoft.Sql/servers/encryptionProtector",
      "location": "Japan East",
      "kind": "azurekeyvault",
      "properties": {
        "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
        "serverKeyType": "AzureKeyVault",
        "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
      }
    }
  ]
}

定义

名称	说明
EncryptionProtector	服务器加密保护程序。
EncryptionProtectorListResult	服务器加密保护程序的列表。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ServerKeyType	加密保护程序类型，例如“ServiceManaged”、“AzureKeyVault”。

EncryptionProtector

Object

服务器加密保护程序。

名称	类型	说明
id	string	资源 ID。
kind	string	加密保护程序的类型。 这是用于 Azure 门户体验的元数据。
location	string	资源位置。
name	string	资源名称。
properties.autoRotationEnabled	boolean	密钥自动轮换选择加入标志。 true 或 false。
properties.serverKeyName	string	服务器密钥的名称。
properties.serverKeyType	ServerKeyType	加密保护程序类型，例如“ServiceManaged”、“AzureKeyVault”。
properties.subregion	string	加密保护器的子区域。
properties.thumbprint	string	服务器密钥的指纹。
properties.uri	string	服务器密钥的 URI。
type	string	资源类型。

EncryptionProtectorListResult

Object

服务器加密保护程序的列表。

名称	类型	说明
nextLink	string	用于检索下一页结果的链接。
value	EncryptionProtector[]	结果数组。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ServerKeyType

枚举

加密保护程序类型，例如“ServiceManaged”、“AzureKeyVault”。

值	说明
AzureKeyVault
ServiceManaged