Server Keys - Create Or Update

參考

服務:: SQL Database

API 版本:: 2021-11-01

建立或更新伺服器金鑰。

PUT 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	要 (更新或建立) 的伺服器金鑰名稱。索引鍵名稱的格式必須是『vault_key_version』。例如，如果keyId為 https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion，則伺服器金鑰名稱的格式應為：YourVaultName_YourKeyName_YourKeyVersion
resourceGroupName	path	True	string	包含資源的資源群組名稱。您可以從 Azure 資源管理員 API 或入口網站取得這個值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	可識別 Azure 訂用帳戶的訂用帳戶識別碼。
api-version	query	True	string	要用於要求的 API 版本。

要求本文

名稱	必要	類型	Description
properties.serverKeyType	True	ServerKeyType	伺服器密鑰類型，例如 'ServiceManaged'、'AzureKeyVault'。
properties.uri		string	伺服器金鑰的 URI。如果 ServerKeyType 是 AzureKeyVault，則需要 URI。 AKV URI 必須以此格式為：'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'

回應

名稱	類型	Description
200 OK	ServerKey	已成功更新伺服器金鑰。
201 Created	ServerKey	已成功建立伺服器金鑰。
202 Accepted		已接受
Other Status Codes		錯誤回應： ≦ 400 InvalidKeyName - 為伺服器金鑰名稱指定了無效的值。 400 InvalidKeyType - 不支援建立伺服器密鑰類型。 400 InvalidUpsertKeyType - 服務管理的 TDE 金鑰是由服務管理。服務管理的 TDE 金鑰不支援使用者建立或更新。 400 InvalidKeyUpsertRequest - 建立伺服器密鑰要求不存在或沒有屬性物件。 400 SecurityAdalPrincipalCertExpiredError - 作業無法完成，因為 Azure 金鑰保存庫主體憑證已過期。 400 AkvHostNotResolvingFromNode - 伺服器 '' 上的{1} AKV 主機 '{0}' 無法從 SQL 解析。 400 SecurityInvalidAzureKeyVaultRecoveryLevel - 提供的金鑰保存庫 URI 無效。 400 KeyMaterialNotFoundOnRemoteServer - 遠端伺服器無法存取做為 TDE 保護裝置的金鑰數據。 400 AzureKeyVaultRsaKeyNotSupported - 提供的密鑰保存庫使用不支援的 RSA 金鑰大小或密鑰類型。支援的 RSA 金鑰大小為 2048 或 3072，金鑰類型為 RSA 或 RSA-HSM。 400 AzureKeyVaultKeyDisabled - 無法完成伺服器上的作業，因為 Azure 金鑰保存庫密鑰已停用。 400 AzureKeyVaultInvalidExpirationDate - 作業無法完成，因為 Azure 金鑰保存庫密鑰到期日無效。 400 SameKeyUriNotFoundOnRemoteServer - 輔助伺服器沒有與主伺服器加密保護裝置相同的密鑰保存庫的密鑰數據，且已啟用密鑰自動輪替。 400 SecurityAzureKeyVaultUrlNullOrEmpty - 作業無法完成，因為 Azure 金鑰保存庫 Uri 為 Null 或空白。 400 SameKeyMaterialNotFoundOnRemoteServer - 輔助伺服器沒有主伺服器加密保護裝置的密鑰數據。 400 PerDatabaseCMKRestoreNotSupported - 在預覽中設定資料庫層級 CMK 時，不支持資料庫還原。 400 AzureKeyVaultNoServerIdentity - 未正確設定伺服器識別。 400 PerDatabaseCMKHSNotSupported - 超大規模資料庫版本不支援預覽版的資料庫層級 CMK。 400 AzureKeyVaultInvalidUri - 來自 Azure 金鑰保存庫的無效回應。請使用有效的 Azure 金鑰保存庫 URI。 400 AzureKeyVaultMissingPermissions - 伺服器缺少 Azure 金鑰保存庫的必要許可權。 400 UmiMissingAkvPermissions - 使用者所提供的 PrimaryUserAssignedIdentityId 無法存取提供的 KeyId 400 AkvEndpointNotReachableFromNode - 無法在伺服器 '' 上從 SQL 連線到 AKV 端點 '{0}{1}'。 400 SecurityAzureKeyVaultInvalidKeyName - 作業無法完成，因為伺服器密鑰名稱無效。 400 AdalGenericError - 作業無法完成，因為發生 Azure Active Directory 錯誤。 400 AdalServicePrincipalNotFound - 作業無法完成，因為發生 Azure Active Directory 連結庫服務主體找不到錯誤。 400 AzureKeyVaultMalformedVaultUri - 提供的金鑰保存庫 URI 無效。 400 SecurityAzureKeyVaultGeoChainError - 使用 Azure 金鑰保存庫 (BYOK) 啟用透明數據加密時，不支援建立次要 (的次要 (稱為鏈結) 。 400 PerDatabaseCMKDWNotSupported - Datawarehouse 版本不支援預覽中的資料庫層級 CMK。 400 SecurityAdalPrincipalCertExpiredError - 作業無法完成，因為 Azure 金鑰保存庫主體憑證已過期。 400 AkvHostNotResolvingFromNode - 伺服器 '' 上的{1} AKV 主機 '{0}' 無法從 SQL 解析。 400 SecurityInvalidAzureKeyVaultRecoveryLevel - 提供的金鑰保存庫 URI 無效。 400 KeyMaterialNotFoundOnRemoteServer - 遠端伺服器無法存取做為 TDE 保護裝置的金鑰數據。 400 AzureKeyVaultRsaKeyNotSupported - 提供的密鑰保存庫使用不支援的 RSA 金鑰大小或密鑰類型。支援的 RSA 金鑰大小為 2048 或 3072，金鑰類型為 RSA 或 RSA-HSM。 400 AzureKeyVaultKeyDisabled - 無法完成伺服器上的作業，因為 Azure 金鑰保存庫密鑰已停用。 400 AzureKeyVaultInvalidExpirationDate - 作業無法完成，因為 Azure 金鑰保存庫密鑰到期日無效。 400 SameKeyUriNotFoundOnRemoteServer - 輔助伺服器沒有與主伺服器加密保護裝置相同的密鑰保存庫的密鑰數據，且已啟用密鑰自動輪替。 400 SecurityAzureKeyVaultUrlNullOrEmpty - 作業無法完成，因為 Azure 金鑰保存庫 Uri 為 Null 或空白。 400 SameKeyMaterialNotFoundOnRemoteServer - 輔助伺服器沒有主伺服器加密保護裝置的密鑰數據。 400 PerDatabaseCMKRestoreNotSupported - 在預覽中設定資料庫層級 CMK 時，不支持資料庫還原。 400 AzureKeyVaultNoServerIdentity - 未正確設定伺服器識別。 400 PerDatabaseCMKHSNotSupported - 超大規模資料庫版本不支援預覽版的資料庫層級 CMK。 400 AzureKeyVaultInvalidUri - 來自 Azure 金鑰保存庫的無效回應。請使用有效的 Azure 金鑰保存庫 URI。 400 AzureKeyVaultMissingPermissions - 伺服器缺少 Azure 金鑰保存庫的必要許可權。 400 UmiMissingAkvPermissions - 使用者所提供的 PrimaryUserAssignedIdentityId 無法存取提供的 KeyId 400 AkvEndpointNotReachableFromNode - 無法在伺服器 '' 上從 SQL 連線到 AKV 端點 '{0}{1}'。 400 SecurityAzureKeyVaultInvalidKeyName - 作業無法完成，因為伺服器密鑰名稱無效。 400 AdalGenericError - 作業無法完成，因為發生 Azure Active Directory 錯誤。 400 AdalServicePrincipalNotFound - 作業無法完成，因為發生 Azure Active Directory 連結庫服務主體找不到錯誤。 400 AzureKeyVaultMalformedVaultUri - 提供的金鑰保存庫 URI 無效。 400 SecurityAzureKeyVaultGeoChainError - 使用 Azure 金鑰保存庫 (BYOK) 啟用透明數據加密時，不支援建立次要 (的次要 (稱為鏈結) 。 400 PerDatabaseCMKDWNotSupported - Datawarehouse 版本不支援預覽中的資料庫層級 CMK。 404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器 404 ServerNotInSubscriptionResourceGroup - 指定的伺服器不存在於指定的資源群組和訂用帳戶中。 404 ResourceNotFound - 找不到所要求的資源。 404 OperationIdNotFound - 標識符為的作業不存在。 409 ServerKeyNameAlreadyExists - 伺服器密鑰已存在於伺服器上。 409 ServerKeyUriAlreadyExists - 伺服器密鑰 URI 已存在於伺服器上。「409 ServerKeyDoesNotExists - 伺服器金鑰不存在。」 409 AzureKeyVaultKeyNameNotFound - 作業無法完成，因為 Azure 金鑰保存庫密鑰名稱不存在。 409 AzureKeyVaultKeyInUse - 伺服器目前正在使用密鑰。 409 ServerKeyNameAlreadyExists - 伺服器密鑰已存在於伺服器上。 409 ServerKeyUriAlreadyExists - 伺服器密鑰 URI 已存在於伺服器上。「409 ServerKeyDoesNotExists - 伺服器金鑰不存在。」 409 AzureKeyVaultKeyNameNotFound - 作業無法完成，因為 Azure 金鑰保存庫密鑰名稱不存在。 409 AzureKeyVaultKeyInUse - 伺服器目前正在使用密鑰。 409 OperationCancelled - 使用者已取消作業。 409 OperationInterrupted - 無法完成資源上的作業，因為它被相同資源上的另一個作業中斷。 429 SubscriptionTooManyCreateUpdateRequests - 超出可用資源可處理之最大要求的要求。 429 SubscriptionTooManyRequests - 超出可用資源可處理之最大要求的要求。 500 OperationTimedOut - 作業逾時並自動回復。請重試該作業。 503 AzureKeyVaultConnectionFailed - 無法在伺服器上完成作業，因為嘗試連線到 Azure 金鑰保存庫失敗 503 AzureKeyVaultGenericConnectionError - 作業無法完成，因為嘗試擷取金鑰保存庫資訊時發生錯誤。 503 AzureKeyVaultConnectionFailed - 無法在伺服器上完成作業，因為嘗試連線到 Azure 金鑰保存庫失敗 503 AzureKeyVaultGenericConnectionError - 作業無法完成，因為嘗試擷取金鑰保存庫資訊時發生錯誤。 503 TooManyRequests - 超出可用資源可處理之最大要求的要求。

範例

Creates or updates a server key

PUT 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

{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
  }
}


import com.azure.resourcemanager.sql.fluent.models.ServerKeyInner;
import com.azure.resourcemanager.sql.models.ServerKeyType;

/**
 * Samples for ServerKeys CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerKeyCreateOrUpdate.json
     */
    /**
     * Sample code: Creates or updates a server key.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createsOrUpdatesAServerKey(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerKeys().createOrUpdate("sqlcrudtest-7398",
            "sqlcrudtest-4645", "someVault_someKey_01234567890123456789012345678901",
            new ServerKeyInner().withServerKeyType(ServerKeyType.AZURE_KEY_VAULT)
                .withUri("https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"),
            com.azure.core.util.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

範例回覆

狀態碼:: 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
  }
}

狀態碼:: 201

{
  "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
  }
}

狀態碼:: 202

定義

名稱	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

共用方式為

Server Keys - Create Or Update

URI 參數

要求本文

回應

範例

Creates or updates a server key

範例要求

範例回覆

定義

ServerKey

ServerKeyType

其他資源