Server Keys - Create Or Update

Service:
SQL Database
API Version:
2020-11-01-preview

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=2020-11-01-preview

URI Parametreleri

Name In Required Type Description
keyName
 path True
  • string

Üzerinde işletilenecek sunucu anahtarının adı (güncelleştirilmiş veya oluşturuldu). Anahtar adının ' vault_key_version ' biçiminde olması gerekir. Örneğin, keyId ise https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion , sunucu anahtarı adı şöyle biçimlendirilmelidir: YourVaultName_YourKeyName_YourKeyVersion
resourceGroupName
 path True
  • string

Kaynağı içeren kaynak grubunun adı. Bu değeri Azure Resource Manager API 'sinden veya portalından elde edebilirsiniz.
serverName
 path True
  • string

Sunucunun adı.
subscriptionId
 path True
  • string

Bir 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 Required Type Description
properties.serverKeyType True

' ServiceManaged ', ' AzureKeyVault ' gibi sunucu anahtarı türü.
properties.uri
  • string

Sunucu anahtarının URI 'SI. ServerKeyType AzureKeyVault ise URI gereklidir.

Yanıtlar

Name Type Description
200 OK

Sunucu anahtarı başarıyla güncelleştirildi.
201 Created

Sunucu anahtarı başarıyla oluşturuldu.
202 Accepted

Kabul edildi
Other Status Codes

Hata yanıtları: * * _

_ 400 ınvalidkeyname-sunucu anahtar adı için geçersiz bir değer verildi.

  • 400 ınvalidkeytype-sunucu oluşturma anahtar türü desteklenmiyor.

  • 400 InvalidUpsertKeyType-Service-Managed TDE anahtarları hizmet tarafından yönetilir. Hizmet tarafından yönetilen TDE anahtarları, Kullanıcı tarafından oluşturma veya güncelleştirmeyi desteklemez.

  • 400 InvalidKeyUpsertRequest-sunucu oluşturma anahtar isteği yok veya hiçbir özellik nesnesine sahip değil.

  • 400 Securityadalsprincipalcertexpiretno-Azure Key Vault asıl sertifikanın süresi sona erdiğinden işlem tamamlanamadı.

  • 400 Securityınvalidazurekeyvaultrecoverylevel-belirtilen Key Vault URI 'si geçerli değil.

  • 400 Keymaterialnotfoundonuzaksunucu-uzak sunucunun TDE koruyucusu olarak kullanılan anahtar malzemesine erişimi yok.

  • 400 AzureKeyVaultMismatchError-http yanıtında beklenmeyen Key Vault bölgesi bulundu.

  • 400 AzureKeyVaultRsaKeyNotSupported-belirtilen anahtar kasası desteklenmeyen RSA anahtar boyutu veya anahtar türü kullanıyor. Desteklenen RSA anahtar boyutu 2048 veya 3072, anahtar türü RSA veya RSA-HSM ' dir.

  • 400 AzureKeyVaultInvalidExpirationDate-Azure Key Vault anahtar sona erme tarihi geçersiz olduğundan işlem tamamlanamadı.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty-Azure Key Vault Uri null veya boş olduğundan işlem tamamlanamadı.

  • 400 AzureKeyVaultInvalidUri-Azure Key Vault geçersiz bir yanıt. Lütfen geçerli bir Azure Key Vault URI 'SI kullanın.

  • 400 SecurityAzureKeyVaultInvalidKeyName-geçersiz bir sunucu anahtar adı nedeniyle işlem tamamlanamadı.

  • 400 AzureKeyVaultMalformedVaultUri-belirtilen Key Vault URI 'si geçerli değil.

  • 400 SecurityAzureKeyVaultGeoChainError-Azure Key Vault (BYOK) kullanılarak Saydam Veri Şifrelemesi etkinleştirilirken, ikincil/ikincil oluşturma (zincirleme olarak bilinen bir işlem) desteklenmez.

  • 400 Securityadalsprincipalcertexpiretno-Azure Key Vault asıl sertifikanın süresi sona erdiğinden işlem tamamlanamadı.

  • 400 Securityınvalidazurekeyvaultrecoverylevel-belirtilen Key Vault URI 'si geçerli değil.

  • 400 Keymaterialnotfoundonuzaksunucu-uzak sunucunun TDE koruyucusu olarak kullanılan anahtar malzemesine erişimi yok.

  • 400 AzureKeyVaultMismatchError-http yanıtında beklenmeyen Key Vault bölgesi bulundu.

  • 400 AzureKeyVaultRsaKeyNotSupported-belirtilen anahtar kasası desteklenmeyen RSA anahtar boyutu veya anahtar türü kullanıyor. Desteklenen RSA anahtar boyutu 2048 veya 3072, anahtar türü RSA veya RSA-HSM ' dir.

  • 400 AzureKeyVaultInvalidExpirationDate-Azure Key Vault anahtar sona erme tarihi geçersiz olduğundan işlem tamamlanamadı.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty-Azure Key Vault Uri null veya boş olduğundan işlem tamamlanamadı.

  • 400 AzureKeyVaultInvalidUri-Azure Key Vault geçersiz bir yanıt. Lütfen geçerli bir Azure Key Vault URI 'SI kullanın.

  • 400 SecurityAzureKeyVaultInvalidKeyName-geçersiz bir sunucu anahtar adı nedeniyle işlem tamamlanamadı.

  • 400 AzureKeyVaultMalformedVaultUri-belirtilen Key Vault URI 'si geçerli değil.

  • 400 SecurityAzureKeyVaultGeoChainError-Azure Key Vault (BYOK) kullanılarak Saydam Veri Şifrelemesi etkinleştirilirken, ikincil/ikincil oluşturma (zincirleme olarak bilinen bir işlem) desteklenmez.

  • 401 AzureKeyVaultKeyDisabled-Azure Key Vault anahtarı devre dışı bırakıldığından işlem sunucuda tamamlanamadı.

  • 401 AzureKeyVaultNoServerIdentity-sunucu kimliği doğru yapılandırılmamış.

  • 401 AzureKeyVaultMissingPermissions-sunucuda gerekli izinler eksik Azure Key Vault.

  • 401 AdalGenericError-bir Azure Active Directory hatasıyla karşılaşıldığından işlem tamamlanamadı.

  • 401 AdalServicePrincipalNotFound-Azure Active Directory kitaplık hizmeti sorumlusu bulunamadı hatasıyla karşılaşıldığından işlem tamamlanamadı.

  • 401 AzureKeyVaultKeyDisabled-Azure Key Vault anahtarı devre dışı bırakıldığından işlem sunucuda tamamlanamadı.

  • 401 AzureKeyVaultNoServerIdentity-sunucu kimliği doğru yapılandırılmamış.

  • 401 AzureKeyVaultMissingPermissions-sunucuda gerekli izinler eksik Azure Key Vault.

  • 401 AdalGenericError-bir Azure Active Directory hatasıyla karşılaşıldığından işlem tamamlanamadı.

  • 401 AdalServicePrincipalNotFound-Azure Active Directory kitaplık hizmeti sorumlusu bulunamadı hatasıyla karşılaşıldığından işlem tamamlanamadı.

  • 404 Subscriptionlınothaveserver-istenen sunucu bulunamadı

  • 404 ServerNotInSubscriptionResourceGroup-belirtilen sunucu, belirtilen kaynak grubunda ve abonelikte yok.

  • 404 ResourceNotFound-istenen kaynak bulunamadı.

  • 409 ServerKeyNameAlreadyExists-sunucu anahtarı sunucuda zaten var.

  • 409 ServerKeyUriAlreadyExists-sunucu anahtarı URI 'SI sunucuda zaten var.

  • 409 Serverkeybir notexists-sunucu anahtarı yok.

  • 409 AzureKeyVaultKeyNameNotFound-Azure Key Vault anahtar adı bulunmadığı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 Serverkeybir notexists-sunucu anahtarı yok.

  • 409 AzureKeyVaultKeyNameNotFound-Azure Key Vault anahtar adı bulunmadığından işlem tamamlanamadı.

  • 409 AzureKeyVaultKeyInUse-anahtar şu anda sunucu tarafından kullanılıyor.

  • 503 AzureKeyVaultConnectionFailed-Azure Key Vault bağlanma girişimleri başarısız olduğundan sunucu üzerinde 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 sunucu üzerinde işlem tamamlanamadı

  • 503 AzureKeyVaultGenericConnectionError-Key Vault bilgileri alınmaya çalışılırken bir hatayla karşılaşıldığından işlem tamamlanamadı.

Örnekler

Creates or updates a server key

Sample Request

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=2020-11-01-preview
Request Body
{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
  }
}

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

ServerKey

Bir sunucu anahtarı.
ServerKeyType

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

ServerKey

Bir sunucu anahtarı.

Name Type Description
id
  • string

Kaynak KIMLIĞI.
kind
  • string

Şifreleme koruyucusu türü. Bu, Azure portal deneyimi için kullanılan meta verileridir.
location
  • string

Kaynak konumu.
name
  • string

Kaynak adı.
properties.autoRotationEnabled
  • boolean

Anahtar otomatik döndürme katılım bayrağı. True ya da false.
properties.creationDate
  • string

Sunucu anahtarı oluşturma tarihi.
properties.serverKeyType

' ServiceManaged ', ' AzureKeyVault ' gibi sunucu anahtarı türü.
properties.subregion
  • string

Sunucu anahtarının alt bölgesi.
properties.thumbprint
  • string

Sunucu anahtarının parmak izi.
properties.uri
  • string

Sunucu anahtarının URI 'SI. ServerKeyType AzureKeyVault ise URI gereklidir.
type
  • string

Kaynak türü.

ServerKeyType

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

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string