Condividi tramite

Encryption Protectors - Create Or Update

  • Riferimento
Servizio:
SQL Database
Versione API:
2023-08-01

Aggiorna una protezione di crittografia esistente.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/encryptionProtector/current?api-version=2023-08-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
encryptionProtectorName
 path True

EncryptionProtectorName

Nome della protezione di crittografia da aggiornare.
resourceGroupName
 path True

string

Nome del gruppo di risorse che contiene la risorsa. È possibile ottenere questo valore dall'API di Azure Resource Manager o dal portale.
serverName
 path True

string

Nome del server.
subscriptionId
 path True

string

ID sottoscrizione che identifica una sottoscrizione di Azure.
api-version
 query True

string

Versione dell'API da usare per la richiesta.

Corpo della richiesta

Nome Necessario Tipo Descrizione
properties.serverKeyType True

ServerKeyType

Tipo di protezione di crittografia come "ServiceManaged", "AzureKeyVault".
properties.autoRotationEnabled

boolean

Flag di consenso esplicito per la rotazione automatica delle chiavi. True o false.
properties.serverKeyName

string

Nome della chiave del server.

Risposte

Nome Tipo Descrizione
200 OK

EncryptionProtector

Aggiornamento corretto della protezione della crittografia.
202 Accepted

Accettato

Intestazioni

Location: string
Other Status Codes

ErrorResponse

Risposte di errore:

  • 400 ManagedInstanceStoppingOrStopped - Operazione in conflitto inviata mentre l'istanza è in stato di arresto/arresto

  • 400 ManagedInstanceStarting - Operazione in conflitto inviata mentre l'istanza è in stato di avvio

  • 400 InvalidKeyName- È stato assegnato un valore non valido per il nome della chiave del server.

  • 400 InvalidKeyType: il tipo di chiave del server di creazione non è supportato.

  • 400 InvalidUpsertKeyType: le chiavi TDE gestite dal servizio vengono gestite dal servizio. Le chiavi TDE gestite dal servizio non supportano La creazione o l'aggiornamento da parte dell'utente.

  • 400 InvalidKeyUpsertRequest: la richiesta di creazione della chiave server non esiste o non dispone di alcun oggetto proprietà.

  • 400 InvalidEncryptionProtectorName- Il nome della chiave di protezione della crittografia non è supportato.

  • 400 SecurityAdalPrincipalCertExpiredError- Impossibile completare l'operazione perché il certificato dell'entità di insieme di credenziali delle chiavi di Azure è scaduto.

  • 400 AkvHostNotResolvingFromNode - Host AKV '{0}' non è risolvibile da SQL, nel server '{1}'.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel: l'URI dell'insieme di credenziali delle chiavi specificato non è valido.

  • 400 MissingKeyVaultUriForRestore - URI della chiave dell'insieme di credenziali delle chiavi di Azure '{0}' è necessario per ripristinare correttamente il database '{1}' nel server '{2}'.

  • 400 AzureKeyVaultKeyUsedOnGeoPrimary- Impossibile completare l'operazione perché il nome della chiave di Azure Key Vault {0} è attualmente impostato come protezione di crittografia nel database geografico primario.

  • 400 KeyMaterialNotFoundOnRemoteServer - Il server remoto non ha accesso al materiale della chiave usato come protezione TDE.

  • 400 PerDatabaseCMKAKVKeyMaterialMissingOnGeoSecondary: tutti i database nella replica geografica devono contenere lo stesso materiale della chiave della protezione della crittografia del database di origine. Aggiungere la chiave "{0}" con lo stesso materiale della chiave al database di destinazione "{1}".

  • 400 AzureKeyVaultRsaKeyNotSupported: l'insieme di credenziali delle chiavi fornito usa le dimensioni o il tipo di chiave RSA non supportato. Le dimensioni della chiave RSA supportate sono 2048 o 3072 e il tipo di chiave è RSA o RSA-HSM.

  • 400 PerDatabaseCMKAKVKeyUriMissingOnGeoSecondary - Quando la rotazione automatica della protezione TDE a livello di database è abilitata, i database di origine e di destinazione devono essere connessi allo stesso insieme di credenziali delle chiavi. Aggiungere la chiave '{0}' (dallo stesso insieme di credenziali delle chiavi connesso al database di origine) al database di destinazione '{1}'.

  • 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeysWithDatabaseName - Durante il tentativo di replicare un database configurato con la protezione di crittografia a livello di database, le chiavi correnti usate dal database primario devono essere passate al database secondario '{0}'

  • 400 ManagedInstanceNoConditionToMakeDatabaseAccessible - Impossibile completare l'operazione perché non sono disponibili autorizzazioni sufficienti per avviare il flusso di lavoro accessibile nell'istanza gestita {0}.

  • 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId fornito dall'utente non ha accesso a KeyId specificato

  • 400 SameKeyUriNotFoundOnRemoteServer - Il server secondario non dispone del materiale della chiave dello stesso insieme di credenziali delle chiavi della protezione di crittografia del server primario con rotazione automatica della chiave abilitata.

  • 400 SameKeyMaterialNotFoundOnRemoteServer - Il server secondario non dispone del materiale della chiave della protezione di crittografia del server primario.

  • 400 SecurityAzureKeyVaultGeoChainError- La creazione di un database secondario (un processo noto come concatenamento) non è supportata quando si abilita Transparent Data Encryption con Azure Key Vault (BYOK).

  • 400 PerDatabaseCMKDWNotSupported - CmK a livello di database in anteprima non è supportato per l'edizione Datawarehouse.

  • 400 BlockSystemAssignedIdentityForCrossTenantCMK- La chiave gestita tra tenant può essere configurata solo quando il server è configurato con un'identità gestita assegnata dall'utente. Fare riferimento a https://aka.ms/sqltdebyokumi per configurare l'identità gestita assegnata dall'utente.

  • 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - Durante il tentativo di replicare un database configurato con la protezione di crittografia a livello di database, le chiavi correnti usate dal database primario devono essere passate al database secondario.

  • 400 CannotDropDatabaseAKVError: il database {0} nel server {1} non può essere eliminato in modo sicuro perché è crittografato con una chiave gestita dal cliente che non è più accessibile per eseguire l'ultimo backup prima dell'eliminazione. Ripristinare l'accesso ad Azure Key Vault nel server e riconvalidare le chiavi per rendere il database accessibile e quindi procedere con l'eliminazione. Per informazioni dettagliate, vedere https://aka.ms/tdecmkrestorability

  • 400 CreateDatabaseAttemptedWithRotationInProgress - Impossibile eseguire l'operazione di creazione del database in questo momento a causa della rotazione continua delle chiavi Transparent Data Encryption (TDE) nel server. Riprovare più tardi.

  • 400 AzureKeyVaultKeyDisabled- Impossibile completare l'operazione nel server perché la chiave di Azure Key Vault è disabilitata.

  • 400 PerDatabaseCMKRestoreNotSupported - Il ripristino del database non è supportato quando la chiave gestita a livello di database è configurata in anteprima.

  • 400 AzureKeyVaultInvalidExpirationDate- Impossibile completare l'operazione perché la data di scadenza della chiave di Azure Key Vault non è valida.

  • 400 PerDatabaseCMKHSNotSupported - La chiave cmk a livello di database in anteprima non è supportata per l'edizione Hyperscale.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty- Impossibile completare l'operazione perché l'URI di Azure Key Vault è null o vuoto.

  • 400 CMKOperationNotAllowed: l'utente ha tentato di eseguire un'operazione sul server quando il server non ha accesso ad Azure Key Vault.

  • 400 AkvEndpointNotReachableFromNode - Endpoint AKV '{0}' non è raggiungibile da SQL, nel server '{1}'.

  • 400 AzureKeyVaultNoServerIdentity - L'identità del server non è configurata correttamente.

  • 400 AzureKeyVaultInvalidUri: risposta non valida da Azure Key Vault. Usare un URI di Azure Key Vault valido.

  • 400 AzureKeyVaultMissingPermissions: il server non dispone delle autorizzazioni necessarie per Azure Key Vault.

  • 400 AzureKeyVaultKeyNameCurrentlyInUse- Impossibile completare l'operazione perché il nome della chiave di Azure Key Vault {0} è attualmente in uso.

  • 400 AzureKeyVaultKeyThumbprintIsDifferent- Impossibile completare l'operazione perché il materiale della chiave di Azure Key Vault è diverso dalla chiave di protezione di crittografia corrente.

  • 400 SecurityAzureKeyVaultInvalidKeyName- Impossibile completare l'operazione a causa di un nome di chiave server non valido.

  • 400 OldGenerationOfAKVKeyBeingUsedError- L'uso di una versione precedente della chiave AKV come protezione TDE non è consentito. Usare la versione più recente della chiave AKV come protezione di crittografia

  • 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase - Per identità CMK del database non configurata nel database di destinazione.

  • 400 AdalGenericError- Impossibile completare l'operazione perché è stato rilevato un errore di Azure Active Directory.

  • 400 AdalServicePrincipalNotFound- Impossibile completare l'operazione perché non è stato rilevato un errore dell'entità servizio della libreria di Azure Active Directory.

  • 400 AzureKeyVaultMalformedVaultUri: l'URI dell'insieme di credenziali delle chiavi specificato non è valido.

  • 404 ServerNotInSubscriptionResourceGroup - Il server specificato non esiste nel gruppo di risorse e nella sottoscrizione specificati.

  • 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato

  • 404 ResourceNotFound: la risorsa richiesta non è stata trovata.

  • 404 ServerKeyNotFound: la chiave del server richiesta non è stata trovata nella sottoscrizione corrente.

  • 404 OperationIdNotFound - L'operazione con ID non esiste.

  • 409 EncryptionProtectorChangeInProgress - Impossibile aggiornare la protezione della chiave di crittografia del database mentre la modifica della protezione è già in corso

  • 409 ServerKeyNameAlreadyExists - La chiave del server esiste già nel server.

  • 409 ServerKeyUriAlreadyExists: l'URI della chiave del server esiste già nel server.

  • 409 ServerKeyDoesNotExists - La chiave del server non esiste.

  • 409 AzureKeyVaultKeyNameNotFound- Impossibile completare l'operazione perché il nome della chiave di Azure Key Vault non esiste.

  • 409 AzureKeyVaultKeyInUse: la chiave è attualmente usata dal server.

  • 409 CannotCancelOperation: l'operazione di gestione si trova in uno stato che non può essere annullato.

  • 409 OperationCancelled - L'operazione è stata annullata dall'utente.

  • 409 OperationInterrupted - Impossibile completare l'operazione sulla risorsa perché è stata interrotta da un'altra operazione sulla stessa risorsa.

  • 429 SubscriptionTooManyCreateUpdateRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili.

  • 429 SubscriptionTooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili.

  • 500 OperationTimedOut: timeout dell'operazione e rollback automatico. Ripetere l'operazione.

  • 503 AzureKeyVaultConnectionFailed - Impossibile completare l'operazione nel server perché i tentativi di connessione ad Azure Key Vault non sono riusciti

  • 503 AzureKeyVaultGenericConnectionError - Impossibile completare l'operazione perché si è verificato un errore durante il tentativo di recuperare le informazioni di Key Vault.

  • 503 TooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili.

Esempio

Update the encryption protector to key vault
Update the encryption protector to service managed

Update the encryption protector to key vault

Esempio di richiesta

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current?api-version=2023-08-01

{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
    "autoRotationEnabled": false
  }
}

Risposta di esempio

Codice di stato:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/encryptionProtector",
  "location": "West US",
  "kind": "azurekeyvault",
  "properties": {
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
    "serverKeyType": "AzureKeyVault",
    "autoRotationEnabled": false
  }
}
Codice di stato:
202

Update the encryption protector to service managed

Esempio di richiesta

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current?api-version=2023-08-01

{
  "properties": {
    "serverKeyType": "ServiceManaged",
    "serverKeyName": "ServiceManaged"
  }
}

Risposta di esempio

Codice di stato:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/encryptionProtector",
  "location": "West US",
  "kind": "servicemanaged",
  "properties": {
    "serverKeyName": "ServiceManaged",
    "serverKeyType": "ServiceManaged"
  }
}
Codice di stato:
202

Definizioni

Nome Descrizione
EncryptionProtector

Protezione della crittografia del server.
EncryptionProtectorName

Nome della protezione di crittografia da aggiornare.
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore
ServerKeyType

Tipo di protezione di crittografia come "ServiceManaged", "AzureKeyVault".

EncryptionProtector

Object

Protezione della crittografia del server.

Nome Tipo Descrizione
id

string

ID risorsa.
kind

string

Tipo di protezione della crittografia. Si tratta di metadati usati per l'esperienza del portale di Azure.
location

string

Percorso della risorsa.
name

string

Nome risorsa.
properties.autoRotationEnabled

boolean

Flag di consenso esplicito per la rotazione automatica delle chiavi. True o false.
properties.serverKeyName

string

Nome della chiave del server.
properties.serverKeyType

ServerKeyType

Tipo di protezione di crittografia come "ServiceManaged", "AzureKeyVault".
properties.subregion

string

Area secondaria della protezione di crittografia.
properties.thumbprint

string

Identificazione personale della chiave del server.
properties.uri

string

URI della chiave del server.
type

string

Tipo di risorsa.

EncryptionProtectorName

Enumerazione

Nome della protezione di crittografia da aggiornare.

Valore Descrizione
current

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.
type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.
code

string

Codice di errore.
details

ErrorDetail[]

Dettagli dell'errore.
message

string

Messaggio di errore.
target

string

Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

ServerKeyType

Enumerazione

Tipo di protezione di crittografia come "ServiceManaged", "AzureKeyVault".

Valore Descrizione
AzureKeyVault
ServiceManaged