Server Keys - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

Bir sunucu anahtarı oluşturur veya güncelleştirir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
keyName	path	True	string	Üzerinde çalıştırılacak sunucu anahtarının adı (güncelleştirilmiş veya oluşturulmuş). Anahtar adının 'vault_key_version' biçiminde olması gerekir. Örneğin keyId değeri ise https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersionsunucu anahtarı adı şu şekilde biçimlendirilmelidir: YourVaultName_YourKeyName_YourKeyVersion
resourceGroupName	path	True	string	Kaynağı içeren kaynak grubunun adı. Bu değeri Azure Resource Manager API'sinden veya portaldan alabilirsiniz.
serverName	path	True	string	Sunucunun adı.
subscriptionId	path	True	string	Azure aboneliğini tanımlayan abonelik kimliği.
api-version	query	True	string	İstek için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
properties.serverKeyType	True	ServerKeyType	'ServiceManaged', 'AzureKeyVault' gibi sunucu anahtarı türü.
properties.uri		string	Sunucu anahtarının URI'si. ServerKeyType AzureKeyVault ise URI gereklidir. AKV URI'sinin şu biçimde olması gerekir: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'

Yanıtlar

Name	Tür	Description
200 OK	ServerKey	Sunucu anahtarı başarıyla güncelleştirildi.
201 Created	ServerKey	Sunucu anahtarı başarıyla oluşturuldu.
202 Accepted		Kabul edildi
Other Status Codes		Hata Yanıtları: *** 400 InvalidKeyName - Sunucu anahtarı adı için geçersiz bir değer verildi. 400 InvalidKeyType - Sunucu anahtarı oluşturma türü desteklenmiyor. 400 InvalidUpsertKeyType - Hizmet tarafından yönetilen TDE anahtarları hizmet tarafından yönetilir. Hizmet tarafından yönetilen TDE anahtarları, kullanıcı tarafından Oluşturma veya Güncelleştirme'yi desteklemez. 400 InvalidKeyUpsertRequest - Sunucu anahtarı oluşturma isteği yok veya özellik nesnesi yok. 400 SecurityAdalPrincipalCertExpiredError - Azure Key Vault asıl sertifikasının süresi dolduğundan işlem tamamlanamadı. 400 AkvHostNotResolvingFromNode - '{0}' AKV konağı ' ' sunucusundaki{1} SQL'den çözümlenemez. 400 SecurityInvalidAzureKeyVaultRecoveryLevel - Sağlanan Key Vault uri geçerli değil. 400 KeyMaterialNotFoundOnRemoteServer - Uzak sunucunun TDE koruyucusu olarak kullanılan anahtar malzemesine erişimi yok. 400 AzureKeyVaultRsaKeyNotSupported - Sağlanan anahtar kasası desteklenmeyen RSA Anahtar Boyutu veya Anahtar Türü kullanıyor. Desteklenen RSA anahtar boyutu 2048 veya 3072 ve Anahtar Türü RSA veya RSA-HSM'dir. 400 AzureKeyVaultKeyDisabled - Azure Key Vault anahtarı devre dışı bırakıldığından sunucuda işlem tamamlanamadı. 400 AzureKeyVaultInvalidExpirationDate - Azure Key Vault anahtarı son kullanma tarihi geçersiz olduğundan işlem tamamlanamadı. 400 SameKeyUriNotFoundOnRemoteServer - İkincil sunucuda, birincil sunucunun şifreleme koruyucusuyla aynı anahtar kasasından anahtar malzemesi ve anahtar otomatik döndürme etkin değildir. 400 SecurityAzureKeyVaultUrlNullOrEmpty - Azure Key Vault Uri null veya boş olduğundan işlem tamamlanamadı. 400 SameKeyMaterialNotFoundOnRemoteServer - İkincil sunucuda birincil sunucunun şifreleme koruyucusunun anahtar malzemesi yoktur. 400 PerDatabaseCMKRestoreNotSupported - Veritabanı düzeyi CMK önizlemede yapılandırıldığında veritabanı geri yükleme desteklenmez. 400 AzureKeyVaultNoServerIdentity - Sunucu kimliği doğru yapılandırılmamış. 400 PerDatabaseCMKHSNotSupported - Hiper Ölçek sürümü için veritabanı düzeyinde CMK önizlemede desteklenmez. 400 AzureKeyVaultInvalidUri - Azure Key Vault geçersiz bir yanıt. Lütfen geçerli bir Azure Key Vault URI'si kullanın. 400 AzureKeyVaultMissingPermissions - Sunucuda Azure Key Vault gerekli izinler eksik. 400 UmiMissingAkvPermissions - Kullanıcı tarafından sağlanan PrimaryUserAssignedIdentityId'nin sağlanan KeyId erişimi yok 400 AkvEndpointNotReachableFromNode - '{0}' AKV uç noktasına SQL'den '' sunucusundan{1} ulaşılamıyor. 400 SecurityAzureKeyVaultInvalidKeyName - Geçersiz bir Sunucu Anahtarı adı nedeniyle işlem tamamlanamadı. 400 AdalGenericError - Azure Active Directory hatasıyla karşılaşıldığından işlem tamamlanamadı. 400 AdalServicePrincipalNotFound - Azure Active Directory kitaplığı Hizmet Sorumlusu bulunamadı hatasıyla karşılaşıldığından işlem tamamlanamadı. 400 AzureKeyVaultMalformedVaultUri - Sağlanan Key Vault uri geçerli değil. 400 SecurityAzureKeyVaultGeoChainError - Azure Key Vault (BYOK) kullanarak Saydam Veri Şifrelemesi etkinleştirilirken ikincil ikincil (zincirleme olarak bilinen bir işlem) oluşturma desteklenmez. 400 PerDatabaseCMKDWNotSupported - Datawarehouse sürümü için veritabanı düzeyinde CMK önizlemede desteklenmez. 400 SecurityAdalPrincipalCertExpiredError - Azure Key Vault asıl sertifikasının süresi dolduğundan işlem tamamlanamadı. 400 AkvHostNotResolvingFromNode - '{0}' AKV konağı ' ' sunucusundaki{1} SQL'den çözümlenemez. 400 SecurityInvalidAzureKeyVaultRecoveryLevel - Sağlanan Key Vault uri geçerli değil. 400 KeyMaterialNotFoundOnRemoteServer - Uzak sunucunun TDE koruyucusu olarak kullanılan anahtar malzemesine erişimi yok. 400 AzureKeyVaultRsaKeyNotSupported - Sağlanan anahtar kasası desteklenmeyen RSA Anahtar Boyutu veya Anahtar Türü kullanıyor. Desteklenen RSA anahtar boyutu 2048 veya 3072 ve Anahtar Türü RSA veya RSA-HSM'dir. 400 AzureKeyVaultKeyDisabled - Azure Key Vault anahtarı devre dışı bırakıldığından sunucuda işlem tamamlanamadı. 400 AzureKeyVaultInvalidExpirationDate - Azure Key Vault anahtarı son kullanma tarihi geçersiz olduğundan işlem tamamlanamadı. 400 SameKeyUriNotFoundOnRemoteServer - İkincil sunucuda, birincil sunucunun şifreleme koruyucusuyla aynı anahtar kasasından anahtar malzemesi ve anahtar otomatik döndürme etkin değildir. 400 SecurityAzureKeyVaultUrlNullOrEmpty - Azure Key Vault Uri null veya boş olduğundan işlem tamamlanamadı. 400 SameKeyMaterialNotFoundOnRemoteServer - İkincil sunucuda birincil sunucunun şifreleme koruyucusunun anahtar malzemesi yoktur. 400 PerDatabaseCMKRestoreNotSupported - Veritabanı düzeyi CMK önizlemede yapılandırıldığında veritabanı geri yükleme desteklenmez. 400 AzureKeyVaultNoServerIdentity - Sunucu kimliği doğru yapılandırılmamış. 400 PerDatabaseCMKHSNotSupported - Hiper Ölçek sürümü için veritabanı düzeyinde CMK önizlemede desteklenmez. 400 AzureKeyVaultInvalidUri - Azure Key Vault geçersiz bir yanıt. Lütfen geçerli bir Azure Key Vault URI'si kullanın. 400 AzureKeyVaultMissingPermissions - Sunucuda Azure Key Vault gerekli izinler eksik. 400 UmiMissingAkvPermissions - Kullanıcı tarafından sağlanan PrimaryUserAssignedIdentityId'nin sağlanan KeyId erişimi yok 400 AkvEndpointNotReachableFromNode - '{0}' AKV uç noktasına SQL'den '' sunucusundan{1} ulaşılamıyor. 400 SecurityAzureKeyVaultInvalidKeyName - Geçersiz bir Sunucu Anahtarı adı nedeniyle işlem tamamlanamadı. 400 AdalGenericError - Azure Active Directory hatasıyla karşılaşıldığından işlem tamamlanamadı. 400 AdalServicePrincipalNotFound - Azure Active Directory kitaplığı Hizmet Sorumlusu bulunamadı hatasıyla karşılaşıldığından işlem tamamlanamadı. 400 AzureKeyVaultMalformedVaultUri - Sağlanan Key Vault uri geçerli değil. 400 SecurityAzureKeyVaultGeoChainError - Azure Key Vault (BYOK) kullanarak Saydam Veri Şifrelemesi etkinleştirilirken ikincil ikincil (zincirleme olarak bilinen bir işlem) oluşturma desteklenmez. 400 PerDatabaseCMKDWNotSupported - Datawarehouse sürümü için veritabanı düzeyinde CMK önizlemede desteklenmez. 404 SubscriptionDoesNotHaveServer - İstenen sunucu bulunamadı 404 ServerNotInSubscriptionResourceGroup - Belirtilen sunucu belirtilen kaynak grubunda ve abonelikte yok. 404 ResourceNotFound - İstenen kaynak bulunamadı. 404 OperationIdNotFound - Kimlikli işlem yok. 409 ServerKeyNameAlreadyExists - Sunucu anahtarı sunucuda zaten var. 409 ServerKeyUriAlreadyExists - Sunucu anahtarı URI'si sunucuda zaten var. 409 ServerKeyDoesNotExists - Sunucu anahtarı yok. 409 AzureKeyVaultKeyNameNotFound - Azure Key Vault Anahtarı adı mevcut olmadığından işlem tamamlanamadı. 409 AzureKeyVaultKeyInUse - Anahtar şu anda sunucu tarafından kullanılıyor. 409 ServerKeyNameAlreadyExists - Sunucu anahtarı sunucuda zaten var. 409 ServerKeyUriAlreadyExists - Sunucu anahtarı URI'si sunucuda zaten var. 409 ServerKeyDoesNotExists - Sunucu anahtarı yok. 409 AzureKeyVaultKeyNameNotFound - Azure Key Vault Anahtarı adı mevcut olmadığından işlem tamamlanamadı. 409 AzureKeyVaultKeyInUse - Anahtar şu anda sunucu tarafından kullanılıyor. 409 OperationCancelled - İşlem kullanıcı tarafından iptal edildi. 409 İşlem Kesildi - Aynı kaynakta başka bir işlem tarafından kesildiği için kaynak üzerindeki işlem tamamlanamadı. 429 SubscriptionTooManyCreateUpdateRequests - Kullanılabilir kaynaklar tarafından işlenebilen maksimum isteklerin ötesindeki istekler. 429 SubscriptionTooManyRequests - Kullanılabilir kaynaklar tarafından işlenebilen maksimum isteklerin ötesindeki istekler. 500 OperationTimedOut - İşlem zaman aşımına uğradı ve otomatik olarak geri alındı. Lütfen işlemi yeniden deneyin. 503 AzureKeyVaultConnectionFailed - Azure Key Vault bağlanma girişimleri başarısız olduğundan sunucuda işlem tamamlanamadı 503 AzureKeyVaultGenericConnectionError - Key Vault bilgileri alınmaya çalışılırken bir hatayla karşılaşıldığından işlem tamamlanamadı. 503 AzureKeyVaultConnectionFailed - Azure Key Vault bağlanma girişimleri başarısız olduğundan sunucuda işlem tamamlanamadı 503 AzureKeyVaultGenericConnectionError - Key Vault bilgileri alınmaya çalışılırken bir hatayla karşılaşıldığından işlem tamamlanamadı. 503 TooManyRequests - Kullanılabilir kaynaklar tarafından işlenebilen maksimum isteklerin ötesindeki istekler.

Örnekler

Creates or updates a server key

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;
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"),
            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
  }
}

Status code:

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

Status code:

202

Tanımlar

Name	Description
ServerKey	Sunucu anahtarı.
ServerKeyType	'ServiceManaged', 'AzureKeyVault' gibi sunucu anahtarı türü.

ServerKey

Sunucu anahtarı.

Name	Tür	Description
id	string	Kaynak Kimliği.
kind	string	Şifreleme koruyucusu gibi. Bu, Azure portal deneyimi için kullanılan meta verilerdir.
location	string	Kaynak konumu.
name	string	Kaynak adı.
properties.autoRotationEnabled	boolean	Anahtar otomatik döndürme kabul bayrağı. True veya false.
properties.creationDate	string	Sunucu anahtarı oluşturma tarihi.
properties.serverKeyType	ServerKeyType	'ServiceManaged', 'AzureKeyVault' gibi sunucu anahtarı türü.
properties.subregion	string	Sunucu anahtarının alt kaydı.
properties.thumbprint	string	Sunucu anahtarının parmak izi.
properties.uri	string	Sunucu anahtarının URI'si. ServerKeyType AzureKeyVault ise URI gereklidir. AKV URI'sinin şu biçimde olması gerekir: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'
type	string	Kaynak türü.

ServerKeyType

'ServiceManaged', 'AzureKeyVault' gibi sunucu anahtarı türü.

Name	Tür	Description
AzureKeyVault	string
ServiceManaged	string