Encryption Protectors - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

Aggiornamenti una protezione di crittografia esistente.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/encryptionProtector/current?api-version=2021-11-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 contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure 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, ad esempio "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 della protezione di crittografia completata.
202 Accepted		Accettato
Other Status Codes		Risposte di errore: 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 del server non esiste o non ha 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 Key Vault di Azure è scaduto. 400 AkvHostNotResolvingFromNode: l'host AKV '{0}' non è risolvibile da SQL nel server '{1}'. 400 SecurityInvalidAzureKeyVaultRecoveryLevel: l'URI Key Vault specificato non è valido. 400 KeyMaterialNotFoundOnRemoteServer - Il server remoto non ha accesso al materiale della chiave usato come protezione TDE. 400 AzureKeyVaultRsaKeyNotSupported: l'insieme di credenziali delle chiavi fornito usa le dimensioni o il tipo di chiave RSA non supportati. Le dimensioni della chiave RSA supportate sono 2048 o 3072 e il tipo di chiave è RSA o RSA-HSM. 400 AzureKeyVaultKeyDisabled- Impossibile completare l'operazione nel server perché la chiave di Key Vault di Azure è disabilitata. 400 AzureKeyVaultInvalidExpirationDate- Impossibile completare l'operazione perché la data di scadenza della chiave di Azure Key Vault non è valida. 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 SecurityAzureKeyVaultUrlNullOrEmpty- Impossibile completare l'operazione perché l'URI di Azure Key Vault è null o vuoto. 400 SameKeyMaterialNotFoundOnRemoteServer - Il server secondario non dispone del materiale della chiave della protezione di crittografia del server primario. 400 PerDatabaseCMKRestoreNotSupported - Il ripristino del database non è supportato quando la chiave gestita a livello di database è configurata in anteprima. 400 AzureKeyVaultNoServerIdentity: l'identità del server non è configurata correttamente. 400 PerDatabaseCMKHSNotSupported - CmK a livello di database in anteprima non è supportato per l'edizione Hyperscale. 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 l'Key Vault di Azure. 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId fornito dall'utente non ha accesso a KeyId fornito 400 AkvEndpointNotReachableFromNode : l'endpoint AKV '{0}' non è raggiungibile da SQL nel server '{1}'. 400 SecurityAzureKeyVaultInvalidKeyName- Impossibile completare l'operazione a causa di un nome di chiave del server non valido. 400 AdalGenericError- Impossibile completare l'operazione perché è stato rilevato un errore di Azure Active Directory. 400 AdalServicePrincipalNotFound- Impossibile completare l'operazione perché è stato rilevato un errore di entità servizio della libreria di Azure Active Directory. 400 AzureKeyVaultMalformedVaultUri: l'URI Key Vault specificato non è valido. 400 SecurityAzureKeyVaultGeoChainError: la creazione di un database secondario (un processo noto come concatenamento) non è supportata quando si abilita Transparent Data Encryption tramite Azure Key Vault (BYOK). 400 PerDatabaseCMKDWNotSupported - CmK a livello di database in anteprima non è supportato per l'edizione Datawarehouse. 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato 404 ServerNotInSubscriptionResourceGroup - Il server specificato non esiste nel gruppo di risorse e nella sottoscrizione specificati. 404 ResourceNotFound: la risorsa richiesta non è stata trovata. 404 ServerKeyNotFound - La chiave server richiesta non è stata trovata nella sottoscrizione corrente. 404 OperationIdNotFound- L'operazione con ID non esiste. 409 EncryptionProtectorChangeInProgress - Impossibile aggiornare la protezione con 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 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 OperationCancelled - L'operazione è stata annullata dall'utente. 409 Operazione interrotta- 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 Key Vault informazioni . 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

Sample Request

HTTP

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

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.EncryptionProtectorInner;
import com.azure.resourcemanager.sql.models.EncryptionProtectorName;
import com.azure.resourcemanager.sql.models.ServerKeyType;

/** Samples for EncryptionProtectors CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * EncryptionProtectorCreateOrUpdateKeyVault.json
     */
    /**
     * Sample code: Update the encryption protector to key vault.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateTheEncryptionProtectorToKeyVault(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getEncryptionProtectors().createOrUpdate("sqlcrudtest-7398",
            "sqlcrudtest-4645", EncryptionProtectorName.CURRENT,
            new EncryptionProtectorInner().withServerKeyName("fakeTokenPlaceholder")
                .withServerKeyType(ServerKeyType.AZURE_KEY_VAULT).withAutoRotationEnabled(false),
            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/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/encryptionProtector",
  "location": "West US",
  "kind": "azurekeyvault",
  "properties": {
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
    "serverKeyType": "AzureKeyVault",
    "autoRotationEnabled": false
  }
}

Status code:

202

Update the encryption protector to service managed

Sample Request

HTTP

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

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.EncryptionProtectorInner;
import com.azure.resourcemanager.sql.models.EncryptionProtectorName;
import com.azure.resourcemanager.sql.models.ServerKeyType;

/** Samples for EncryptionProtectors CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * EncryptionProtectorCreateOrUpdateServiceManaged.json
     */
    /**
     * Sample code: Update the encryption protector to service managed.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateTheEncryptionProtectorToServiceManaged(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getEncryptionProtectors().createOrUpdate("sqlcrudtest-7398",
            "sqlcrudtest-4645", EncryptionProtectorName.CURRENT, new EncryptionProtectorInner()
                .withServerKeyName("fakeTokenPlaceholder").withServerKeyType(ServerKeyType.SERVICE_MANAGED),
            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/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/encryptionProtector",
  "location": "West US",
  "kind": "servicemanaged",
  "properties": {
    "serverKeyName": "ServiceManaged",
    "serverKeyType": "ServiceManaged"
  }
}

Status code:

202

Definizioni

Nome	Descrizione
EncryptionProtector	Protezione di crittografia del server.
EncryptionProtectorName	Nome della protezione di crittografia da aggiornare.
ServerKeyType	Tipo di protezione di crittografia, ad esempio "ServiceManaged", "AzureKeyVault".

EncryptionProtector

Protezione di crittografia del server.

Nome	Tipo	Descrizione
id	string	ID risorsa.
kind	string	Tipo di protezione di crittografia. Si tratta di metadati usati per l'esperienza di 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, ad esempio "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

Nome della protezione di crittografia da aggiornare.

Nome	Tipo	Descrizione
current	string

ServerKeyType

Tipo di protezione di crittografia, ad esempio "ServiceManaged", "AzureKeyVault".

Nome	Tipo	Descrizione
AzureKeyVault	string
ServiceManaged	string