Encryption Protectors - 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}/encryptionProtector?api-version=2021-11-01

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	可識別 Azure 訂用帳戶的訂用帳戶識別碼。
api-version	query	True	string	要用於要求的 API 版本。

回應

名稱	類型	Description
200 OK	EncryptionProtectorListResult	已成功擷取伺服器加密保護裝置的清單。
Other Status Codes		錯誤回應： ≦ 400 InvalidKeyName - 為伺服器金鑰名稱指定了無效的值。 400 InvalidKeyType - 不支援建立伺服器密鑰類型。 400 InvalidUpsertKeyType - 服務管理的 TDE 金鑰是由服務管理。 服務管理的 TDE 金鑰不支援使用者建立或更新。 400 InvalidKeyUpsertRequest - 建立伺服器密鑰要求不存在或沒有屬性物件。 400 InvalidEncryptionProtectorName - 不支援加密保護裝置密鑰名稱。 404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器 404 ServerNotInSubscriptionResourceGroup - 指定的伺服器不存在於指定的資源群組和訂用帳戶中。

範例

List encryption protectors 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/encryptionProtector?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for EncryptionProtectors ListByServer. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/EncryptionProtectorList.json
     */
    /**
     * Sample code: List encryption protectors by server.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listEncryptionProtectorsByServer(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getEncryptionProtectors().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/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"
      }
    }
  ]
}

定義

名稱	Description
EncryptionProtector	伺服器加密保護裝置。
EncryptionProtectorListResult	伺服器加密保護裝置的清單。
ServerKeyType	加密保護裝置類型，例如 'ServiceManaged'、'AzureKeyVault'。

EncryptionProtector

伺服器加密保護裝置。

名稱	類型	Description
id	string	資源識別碼。
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

伺服器加密保護裝置的清單。

名稱	類型	Description
nextLink	string	連結以擷取下一頁的結果。
value	EncryptionProtector[]	結果陣列。

ServerKeyType

加密保護裝置類型，例如 'ServiceManaged'、'AzureKeyVault'。

名稱	類型	Description
AzureKeyVault	string
ServiceManaged	string