Server Keys - Create Or Update

Kiszolgálókulcsot hoz létre vagy frissít.

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

URI-paraméterek

Name In Required Type Description
keyName
path True
  • string

A működtetni kívánt kiszolgálókulcs neve (frissítve vagy létrehozva). A kulcsnévnek "vault_key_version" formátumban kell lennie. Ha például a keyId https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, akkor a kiszolgálókulcs nevének a következőképpen kell formáznia: YourVaultName_YourKeyName_YourKeyVersion

resourceGroupName
path True
  • string

Az erőforrást tartalmazó erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.

serverName
path True
  • string

A kiszolgáló neve.

subscriptionId
path True
  • string

Az Azure-előfizetést azonosító előfizetés-azonosító.

api-version
query True
  • string

A kéréshez használandó API-verzió.

Kérelem törzse

Name Required Type Description
properties.serverKeyType True

A kiszolgálókulcs típusa, például "ServiceManaged", "AzureKeyVault".

properties.uri
  • string

A kiszolgálókulcs URI-ja. Ha a ServerKeyType az AzureKeyVault, akkor az URI szükséges. Az AKV URI-nak a következő formátumban kell lennie: "https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion"

Válaszok

Name Type Description
200 OK

A kiszolgálókulcs frissítése sikerült.

201 Created

A kiszolgálókulcs létrehozása sikerült.

202 Accepted

Elfogadva

Other Status Codes

Hibaválaszok: ***

  • 400 InvalidKeyName – Érvénytelen érték lett megadva a kiszolgálókulcs nevéhez.

  • 400 InvalidKeyType – A kiszolgálókulcs létrehozása típus nem támogatott.

  • 400 InvalidUpsertKeyType – A szolgáltatás által felügyelt TDE-kulcsokat a szolgáltatás kezeli. A szolgáltatás által felügyelt TDE-kulcsok nem támogatják a felhasználó általi létrehozást vagy frissítést.

  • 400 InvalidKeyUpsertRequest – A kiszolgálókulcs-létrehozási kérelem nem létezik, vagy nincs tulajdonságobjektuma.

  • 400 SecurityAdalPrincipalCertExpiredError – A művelet nem hajtható végre, mert az Azure Key Vault főtanúsítványa lejárt.

  • 400 AkvHostNotResolvingFromNode – Az AKV-gazdagép ('{0}' nem oldható fel az SQL-ből, a(z) ""{1} kiszolgálón.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel – A megadott Key Vault URI érvénytelen.

  • 400 KeyMaterialNotFoundOnRemoteServer – A távoli kiszolgáló nem rendelkezik hozzáféréssel a TDE-védőként használt kulcsanyagokhoz.

  • 400 AzureKeyVaultRsaKeyNotSupported – A megadott kulcstartó nem támogatott RSA-kulcsméretet vagy kulcstípust használ. A támogatott RSA-kulcsméret 2048 vagy 3072, a kulcstípus pedig RSA vagy RSA-HSM.

  • 400 AzureKeyVaultKeyDisabled – A művelet nem hajtható végre a kiszolgálón, mert az Azure Key Vault kulcs le van tiltva.

  • 400 AzureKeyVaultInvalidExpirationDate – A művelet nem hajtható végre, mert az Azure Key Vault kulcs lejárati dátuma érvénytelen.

  • 400 SameKeyUriNotFoundOnRemoteServer – A másodlagos kiszolgáló nem rendelkezik a kulcs anyagával ugyanabban a kulcstartóban, mint az elsődleges kiszolgáló titkosítási védője, és a kulcs automatikus rotálása engedélyezve van.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty – A művelet nem hajtható végre, mert az Azure Key Vault URI null értékű vagy üres.

  • 400 SameKeyMaterialNotFoundOnRemoteServer – A másodlagos kiszolgáló nem rendelkezik az elsődleges kiszolgáló titkosítási védőjének kulcsanyagával.

  • 400 PerDatabaseCMKRestoreNotSupported – Az adatbázis-visszaállítás nem támogatott, ha az adatbázisszintű CMK előzetes verzióban van konfigurálva.

  • 400 AzureKeyVaultNoServerIdentity – A kiszolgálóidentitás nincs megfelelően konfigurálva.

  • 400 PerDatabaseCMKHSNotSupported – Az előzetes verzióban az adatbázisszintű CMK nem támogatott a rugalmas skálázású kiadásban.

  • 400 AzureKeyVaultInvalidUri – Az Azure Key Vault érvénytelen válasza. Használjon érvényes Azure Key Vault URI-t.

  • 400 AzureKeyVaultMissingPermissions – A kiszolgáló nem rendelkezik a szükséges engedélyekkel az Azure Key Vault.

  • 400 UmiMissingAkvPermissions – A felhasználó által megadott PrimaryUserAssignedIdentityId nem rendelkezik hozzáféréssel a megadott KeyId azonosítóhoz

  • 400 AkvEndpointNotReachableFromNode – AKV-végpont "{0}" nem érhető el az SQL-ből, a(z) ""{1} kiszolgálón.

  • 400 SecurityAzureKeyVaultInvalidKeyName – Érvénytelen kiszolgálókulcsnév miatt nem hajtható végre a művelet.

  • 400 AdalGenericError – A művelet nem hajtható végre, mert Azure Active Directory-hiba történt.

  • 400 AdalServicePrincipalNotFound – A művelet nem hajtható végre, mert egy Azure Active Directory-kódtár szolgáltatásneve nem található hiba történt.

  • 400 AzureKeyVaultMalformedVaultUri – A megadott Key Vault URI érvénytelen.

  • 400 SecurityAzureKeyVaultGeoChainError – A másodlagos (láncolásnak nevezett) folyamat másodlagos létrehozása nem támogatott a transzparens adattitkosítás Azure Key Vault (BYOK) használatával történő engedélyezésekor.

  • 400 PerDatabaseCMKDWNotSupported – Az előzetes verzióban az adatbázisszintű CMK nem támogatott a Datawarehouse kiadásban.

  • 400 SecurityAdalPrincipalCertExpiredError – A művelet nem hajtható végre, mert az Azure Key Vault főtanúsítványa lejárt.

  • 400 AkvHostNotResolvingFromNode – Az AKV-gazdagép ('{0}' nem oldható fel az SQL-ből, a(z) ""{1} kiszolgálón.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel – A megadott Key Vault URI érvénytelen.

  • 400 KeyMaterialNotFoundOnRemoteServer – A távoli kiszolgáló nem rendelkezik hozzáféréssel a TDE-védőként használt kulcsanyagokhoz.

  • 400 AzureKeyVaultRsaKeyNotSupported – A megadott kulcstartó nem támogatott RSA-kulcsméretet vagy kulcstípust használ. A támogatott RSA-kulcsméret 2048 vagy 3072, a kulcstípus pedig RSA vagy RSA-HSM.

  • 400 AzureKeyVaultKeyDisabled – A művelet nem hajtható végre a kiszolgálón, mert az Azure Key Vault kulcs le van tiltva.

  • 400 AzureKeyVaultInvalidExpirationDate – A művelet nem hajtható végre, mert az Azure Key Vault kulcs lejárati dátuma érvénytelen.

  • 400 SameKeyUriNotFoundOnRemoteServer – A másodlagos kiszolgáló nem rendelkezik a kulcs anyagával ugyanabban a kulcstartóban, mint az elsődleges kiszolgáló titkosítási védője, és a kulcs automatikus rotálása engedélyezve van.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty – A művelet nem hajtható végre, mert az Azure Key Vault URI null értékű vagy üres.

  • 400 SameKeyMaterialNotFoundOnRemoteServer – A másodlagos kiszolgáló nem rendelkezik az elsődleges kiszolgáló titkosítási védőjének kulcsanyagával.

  • 400 PerDatabaseCMKRestoreNotSupported – Az adatbázis-visszaállítás nem támogatott, ha az adatbázisszintű CMK előzetes verzióban van konfigurálva.

  • 400 AzureKeyVaultNoServerIdentity – A kiszolgálóidentitás nincs megfelelően konfigurálva.

  • 400 PerDatabaseCMKHSNotSupported – Az előzetes verzióban az adatbázisszintű CMK nem támogatott a rugalmas skálázású kiadásban.

  • 400 AzureKeyVaultInvalidUri – Az Azure Key Vault érvénytelen válasza. Használjon érvényes Azure Key Vault URI-t.

  • 400 AzureKeyVaultMissingPermissions – A kiszolgáló nem rendelkezik a szükséges engedélyekkel az Azure Key Vault.

  • 400 UmiMissingAkvPermissions – A felhasználó által megadott PrimaryUserAssignedIdentityId nem rendelkezik hozzáféréssel a megadott KeyId azonosítóhoz

  • 400 AkvEndpointNotReachableFromNode – AKV-végpont "{0}" nem érhető el az SQL-ből, a(z) ""{1} kiszolgálón.

  • 400 SecurityAzureKeyVaultInvalidKeyName – Érvénytelen kiszolgálókulcsnév miatt nem hajtható végre a művelet.

  • 400 AdalGenericError – A művelet nem hajtható végre, mert Azure Active Directory-hiba történt.

  • 400 AdalServicePrincipalNotFound – A művelet nem hajtható végre, mert egy Azure Active Directory-kódtár szolgáltatásneve nem található hiba történt.

  • 400 AzureKeyVaultMalformedVaultUri – A megadott Key Vault URI érvénytelen.

  • 400 SecurityAzureKeyVaultGeoChainError – A másodlagos (láncolásnak nevezett) folyamat másodlagos létrehozása nem támogatott a transzparens adattitkosítás Azure Key Vault (BYOK) használatával történő engedélyezésekor.

  • 400 PerDatabaseCMKDWNotSupported – Az előzetes verzióban az adatbázisszintű CMK nem támogatott a Datawarehouse kiadásban.

  • 404 SubscriptionDoesNotHaveServer – A kért kiszolgáló nem található

  • 404 ServerNotInSubscriptionResourceGroup – A megadott kiszolgáló nem létezik a megadott erőforráscsoportban és előfizetésben.

  • 404 ResourceNotFound – A kért erőforrás nem található.

  • 404 OperationIdNotFound – Az azonosítóval rendelkező művelet nem létezik.

  • 409 ServerKeyNameAlreadyExists – A kiszolgálókulcs már létezik a kiszolgálón.

  • 409 ServerKeyUriAlreadyExists – A kiszolgálókulcs URI-ja már létezik a kiszolgálón.

  • 409 ServerKeyDoesNotExists – A kiszolgálókulcs nem létezik.

  • 409 AzureKeyVaultKeyNameNotFound – A művelet nem hajtható végre, mert az Azure Key Vault kulcsneve nem létezik.

  • 409 AzureKeyVaultKeyInUse – A kulcsot jelenleg a kiszolgáló használja.

  • 409 ServerKeyNameAlreadyExists – A kiszolgálókulcs már létezik a kiszolgálón.

  • 409 ServerKeyUriAlreadyExists – A kiszolgálókulcs URI-ja már létezik a kiszolgálón.

  • 409 ServerKeyDoesNotExists – A kiszolgálókulcs nem létezik.

  • 409 AzureKeyVaultKeyNameNotFound – A művelet nem hajtható végre, mert az Azure Key Vault kulcsneve nem létezik.

  • 409 AzureKeyVaultKeyInUse – A kulcsot jelenleg a kiszolgáló használja.

  • 409 OperationCancelled – A felhasználó megszakította a műveletet.

  • 409 OperationInterrupted – Az erőforráson végzett művelet nem hajtható végre, mert egy másik művelet megszakította ugyanazon az erőforráson.

  • 429 SubscriptionTooManyCreateUpdateRequests – Az elérhető erőforrások által feldolgozható maximális kéréseken túli kérések.

  • 429 SubscriptionTooManyRequests – Az elérhető erőforrások által feldolgozható maximális kéréseken túli kérések.

  • 500 OperationTimedOut – A művelet túllépte az időkorlátot, és automatikusan visszagördült. Please retry the operation.

  • 503 AzureKeyVaultConnectionFailed – A művelet nem hajtható végre a kiszolgálón, mert nem sikerült csatlakozni az Azure Key Vault

  • 503 AzureKeyVaultGenericConnectionError – A művelet nem hajtható végre, mert hiba történt Key Vault információ lekérésekor.

  • 503 AzureKeyVaultConnectionFailed – A művelet nem hajtható végre a kiszolgálón, mert nem sikerült csatlakozni az Azure Key Vault

  • 503 AzureKeyVaultGenericConnectionError – A művelet nem hajtható végre, mert hiba történt Key Vault információ lekérésekor.

  • 503 TooManyRequests – Az elérhető erőforrások által feldolgozható maximális kéréseken túli kérések.

Példák

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=2021-11-01

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

Sample Response

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

Definíciók

ServerKey

Egy kiszolgálókulcs.

ServerKeyType

A kiszolgálókulcs típusa, például "ServiceManaged", "AzureKeyVault".

ServerKey

Egy kiszolgálókulcs.

Name Type Description
id
  • string

Erőforrás-azonosító.

kind
  • string

A titkosítási védő típusa. Ez a Azure Portal-élményhez használt metaadatok.

location
  • string

Erőforrás helye.

name
  • string

Erőforrás neve.

properties.autoRotationEnabled
  • boolean

Kulcs automatikus forgatásának jóváhagyási jelzője. Igaz vagy hamis.

properties.creationDate
  • string

A kiszolgálókulcs létrehozásának dátuma.

properties.serverKeyType

A kiszolgálókulcs típusa, például "ServiceManaged", "AzureKeyVault".

properties.subregion
  • string

A kiszolgálókulcs alrégió.

properties.thumbprint
  • string

A kiszolgálókulcs ujjlenyomata.

properties.uri
  • string

A kiszolgálókulcs URI-ja. Ha a ServerKeyType az AzureKeyVault, akkor az URI szükséges. Az AKV URI-nak a következő formátumban kell lennie: "https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion"

type
  • string

Erőforrástípus.

ServerKeyType

A kiszolgálókulcs típusa, például "ServiceManaged", "AzureKeyVault".

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string