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

Server Keys - List By Server

Service:

SQL Database

API Version:

2021-11-01

获取服务器密钥的列表。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/keys?api-version=2021-11-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	ServerKeyListResult	已成功检索服务器密钥列表。
Other Status Codes		错误响应： *** 400 InvalidKeyName - 为服务器密钥名称提供了无效值。 400 InvalidKeyType - 不支持创建服务器密钥类型。 400 InvalidUpsertKeyType - 服务托管的 TDE 密钥由服务管理。 服务托管的 TDE 密钥不支持用户创建或更新。 400 InvalidKeyUpsertRequest - 创建服务器密钥请求不存在或没有属性对象。 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器 404 ServerNotInSubscriptionResourceGroup - 指定的服务器不存在于指定的资源组和订阅中。

示例

List the server keys by server

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for ServerKeys ListByServer. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerKeyList.json
     */
    /**
     * Sample code: List the server keys by server.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listTheServerKeysByServer(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerKeys().listByServer("sqlcrudtest-7398",
            "sqlcrudtest-4645", 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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
      "name": "someVault_someKey_01234567890123456789012345678901",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "kind": "azurekeyvault",
      "properties": {
        "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
        "creationDate": "2020-11-15T00:00:00Z",
        "autoRotationEnabled": false
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/myVault_myKey_11111111111111111111111111111111",
      "name": "myVault_myKey_11111111111111111111111111111111",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "kind": "azurekeyvault",
      "properties": {
        "thumbprint": "AAAAAAAAAAAAAAABBBBBBBBBBBBBBBBBBBBBBBBB",
        "creationDate": "2020-11-15T00:00:00Z",
        "autoRotationEnabled": false
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/ServiceManaged",
      "name": "ServiceManaged",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "kind": "servicemanaged",
      "properties": {}
    }
  ]
}

定义

名称	说明
ServerKey	服务器密钥。
ServerKeyListResult	服务器密钥的列表。
ServerKeyType	服务器密钥类型，如“ServiceManaged”、“AzureKeyVault”。

ServerKey

服务器密钥。

名称	类型	说明
id	string	资源 ID。
kind	string	加密保护程序的种类。 这是用于Azure 门户体验的元数据。
location	string	资源位置。
name	string	资源名称。
properties.autoRotationEnabled	boolean	密钥自动轮换选择加入标志。 true 或 false。
properties.creationDate	string	服务器密钥创建日期。
properties.serverKeyType	ServerKeyType	服务器密钥类型，如“ServiceManaged”、“AzureKeyVault”。
properties.subregion	string	服务器密钥的子区域。
properties.thumbprint	string	服务器密钥的指纹。
properties.uri	string	服务器密钥的 URI。 如果 ServerKeyType 为 AzureKeyVault，则 URI 是必需的。 AKV URI 必须采用以下格式：“https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion”
type	string	资源类型。

ServerKeyListResult

服务器密钥的列表。

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

ServerKeyType

服务器密钥类型，如“ServiceManaged”、“AzureKeyVault”。

名称	类型	说明
AzureKeyVault	string
ServiceManaged	string