Server Keys - Get

Service:

SQL Database

API Version:

2021-11-01

取得伺服器金鑰。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/keys/{keyName}?api-version=2021-11-01

URI 參數

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

回應

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

範例

Get the server key

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

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

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

定義

名稱	Description
ServerKey	伺服器金鑰。
ServerKeyType	伺服器密鑰類型，例如 'ServiceManaged'、'AzureKeyVault'。

ServerKey

伺服器金鑰。

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

ServerKeyType

伺服器密鑰類型，例如 'ServiceManaged'、'AzureKeyVault'。

名稱	類型	Description
AzureKeyVault	string
ServiceManaged	string