Managed Instance Encryption Protectors - Create Or Update

Référence

Service:: SQL Database

API Version:: 2021-11-01

Mises à jour un protecteur de chiffrement existant.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/encryptionProtector/current?api-version=2021-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
encryptionProtectorName	path	True	EncryptionProtectorName	Nom du protecteur de chiffrement à mettre à jour.
managedInstanceName	path	True	string	Nom de l'instance managée.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.serverKeyType	True	ServerKeyType	Type de protecteur de chiffrement comme « ServiceManaged », « AzureKeyVault ».
properties.autoRotationEnabled		boolean	Indicateur d’activation de la rotation automatique des clés. true ou false.
properties.serverKeyName		string	Nom de la clé de instance gérée.

Réponses

Nom	Type	Description
200 OK	ManagedInstanceEncryptionProtector	Mise à jour réussie du protecteur de chiffrement.
202 Accepted		Accepté
Other Status Codes		Réponses d’erreur : *** 400 InvalidKeyName : une valeur non valide a été donnée pour le nom de la clé de serveur. 400 InvalidKeyType : le type de clé de serveur create n’est pas pris en charge. 400 InvalidUpsertKeyType : les clés TDE gérées par le service sont gérées par le service. Les clés TDE gérées par le service ne prennent pas en charge la création ou la mise à jour par l’utilisateur. 400 InvalidKeyUpsertRequest : la demande de création de clé de serveur n’existe pas ou n’a pas d’objet de propriétés. 400 InvalidEncryptionProtectorName : le nom de clé du protecteur de chiffrement n’est pas pris en charge. 400 SecurityAdalPrincipalCertExpiredError : l’opération n’a pas pu être effectuée, car le certificat principal Azure Key Vault a expiré. 400 AkvHostNotResolvingFromNode : l’hôte AKV «{0} » n’est pas résolvable à partir de SQL, sur le serveur « ».{1} 400 SecurityInvalidAzureKeyVaultRecoveryLevel : l’URI Key Vault fourni n’est pas valide. 400 KeyMaterialNotFoundOnRemoteServer : le serveur distant n’a pas accès au matériel de clé utilisé comme protecteur TDE. 400 AzureKeyVaultRsaKeyNotSupported : le coffre de clés fourni utilise une taille de clé RSA ou un type de clé non pris en charge. La taille de clé RSA prise en charge est 2048 ou 3072 et le type de clé est RSA ou RSA-HSM. 400 AzureKeyVaultKeyDisabled : l’opération n’a pas pu être effectuée sur le serveur, car la clé Azure Key Vault est désactivée. 400 AzureKeyVaultInvalidExpirationDate : l’opération n’a pas pu être terminée, car la date d’expiration de la clé Azure Key Vault n’est pas valide. 400 SameKeyUriNotFoundOnRemoteServer : le serveur secondaire n’a pas le matériel de clé du même coffre de clés que le protecteur de chiffrement du serveur principal avec la rotation automatique des clés activée. 400 SecurityAzureKeyVaultUrlNullOrEmpty : l’opération n’a pas pu être effectuée, car l’URI azure Key Vault est null ou vide. 400 SameKeyMaterialNotFoundOnRemoteServer : le serveur secondaire n’a pas le matériel de clé du protecteur de chiffrement du serveur principal. 400 PerDatabaseCMKRestoreNotSupported : la restauration de base de données n’est pas prise en charge lorsque la clé CMK au niveau de la base de données est configurée en préversion. 400 AzureKeyVaultNoServerIdentity : l’identité du serveur n’est pas correctement configurée. 400 PerDatabaseCMKHSNotSupported : cmk au niveau de la base de données en préversion n’est pas pris en charge pour l’édition Hyperscale. 400 AzureKeyVaultInvalidUri : réponse non valide d’Azure Key Vault. Utilisez un URI de Key Vault Azure valide. 400 AzureKeyVaultMissingPermissions : le serveur n’a pas les autorisations requises sur le Key Vault Azure. 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId fourni par l’utilisateur n’a pas accès à KeyId fourni 400 AkvEndpointNotReachableFromNode : le point de terminaison AKV «{0} » n’est pas accessible à partir de SQL, sur le serveur « ».{1} 400 SecurityAzureKeyVaultInvalidKeyName : l’opération n’a pas pu être effectuée en raison d’un nom de clé de serveur non valide. 400 AdalGenericError : l’opération n’a pas pu être terminée, car une erreur Azure Active Directory a été rencontrée. 400 AdalServicePrincipalNotFound : l’opération n’a pas pu être terminée, car une erreur de principal de service introuvable dans la bibliothèque Azure Active Directory a été rencontrée. 400 AzureKeyVaultMalformedVaultUri : l’URI de Key Vault fourni n’est pas valide. 400 SecurityAzureKeyVaultGeoChainError : la création d’un composant secondaire (un processus appelé chaînage) n’est pas prise en charge lors de l’activation de Transparent Data Encryption à l’aide d’Azure Key Vault (BYOK). 400 PerDatabaseCMKDWNotSupported : la clé CMK au niveau de la base de données en préversion n’est pas prise en charge pour l’édition Datawarehouse. 404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés. 404 ResourceNotFound : la ressource demandée est introuvable. 404 ServerKeyNotFound - la clé serveur demandée est introuvable sur l’abonnement actuel. 404 OperationIdNotFound : l’opération avec ID n’existe pas. 409 EncryptionProtectorChangeInProgress : impossible de mettre à jour le protecteur de clé de chiffrement de base de données alors que la modification du protecteur est déjà en cours 409 ServerKeyNameAlreadyExists : la clé de serveur existe déjà sur le serveur. 409 ServerKeyUriAlreadyExists : l’URI de clé de serveur existe déjà sur le serveur. 409 ServerKeyDoesNotExists - la clé du serveur n’existe pas. 409 AzureKeyVaultKeyNameNotFound : l’opération n’a pas pu être effectuée, car le nom de la clé Azure Key Vault n’existe pas. 409 AzureKeyVaultKeyInUse : la clé est actuellement utilisée par le serveur. 409 OperationCancelled : l’opération a été annulée par l’utilisateur. 409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource. 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 500 OperationTimedOut : l’opération a expiré et a été automatiquement restaurée. Réessayez l’opération. 503 AzureKeyVaultConnectionFailed : l’opération n’a pas pu être effectuée sur le serveur, car les tentatives de connexion à Azure Key Vault ont échoué 503 AzureKeyVaultGenericConnectionError : l’opération n’a pas pu être terminée, car une erreur s’est produite lors de la tentative de récupération des informations Key Vault . 503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.

Nom

Type

Description

200 OK

ManagedInstanceEncryptionProtector

Mise à jour réussie du protecteur de chiffrement.

202 Accepted

Accepté

Other Status Codes

Réponses d’erreur : ***

400 InvalidKeyName : une valeur non valide a été donnée pour le nom de la clé de serveur.
400 InvalidKeyType : le type de clé de serveur create n’est pas pris en charge.
400 InvalidUpsertKeyType : les clés TDE gérées par le service sont gérées par le service. Les clés TDE gérées par le service ne prennent pas en charge la création ou la mise à jour par l’utilisateur.
400 InvalidKeyUpsertRequest : la demande de création de clé de serveur n’existe pas ou n’a pas d’objet de propriétés.
400 InvalidEncryptionProtectorName : le nom de clé du protecteur de chiffrement n’est pas pris en charge.
400 SecurityAdalPrincipalCertExpiredError : l’opération n’a pas pu être effectuée, car le certificat principal Azure Key Vault a expiré.
400 AkvHostNotResolvingFromNode : l’hôte AKV «{0} » n’est pas résolvable à partir de SQL, sur le serveur « ».{1}
400 SecurityInvalidAzureKeyVaultRecoveryLevel : l’URI Key Vault fourni n’est pas valide.
400 KeyMaterialNotFoundOnRemoteServer : le serveur distant n’a pas accès au matériel de clé utilisé comme protecteur TDE.
400 AzureKeyVaultRsaKeyNotSupported : le coffre de clés fourni utilise une taille de clé RSA ou un type de clé non pris en charge. La taille de clé RSA prise en charge est 2048 ou 3072 et le type de clé est RSA ou RSA-HSM.
400 AzureKeyVaultKeyDisabled : l’opération n’a pas pu être effectuée sur le serveur, car la clé Azure Key Vault est désactivée.
400 AzureKeyVaultInvalidExpirationDate : l’opération n’a pas pu être terminée, car la date d’expiration de la clé Azure Key Vault n’est pas valide.
400 SameKeyUriNotFoundOnRemoteServer : le serveur secondaire n’a pas le matériel de clé du même coffre de clés que le protecteur de chiffrement du serveur principal avec la rotation automatique des clés activée.
400 SecurityAzureKeyVaultUrlNullOrEmpty : l’opération n’a pas pu être effectuée, car l’URI azure Key Vault est null ou vide.
400 SameKeyMaterialNotFoundOnRemoteServer : le serveur secondaire n’a pas le matériel de clé du protecteur de chiffrement du serveur principal.
400 PerDatabaseCMKRestoreNotSupported : la restauration de base de données n’est pas prise en charge lorsque la clé CMK au niveau de la base de données est configurée en préversion.
400 AzureKeyVaultNoServerIdentity : l’identité du serveur n’est pas correctement configurée.
400 PerDatabaseCMKHSNotSupported : cmk au niveau de la base de données en préversion n’est pas pris en charge pour l’édition Hyperscale.
400 AzureKeyVaultInvalidUri : réponse non valide d’Azure Key Vault. Utilisez un URI de Key Vault Azure valide.
400 AzureKeyVaultMissingPermissions : le serveur n’a pas les autorisations requises sur le Key Vault Azure.
400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId fourni par l’utilisateur n’a pas accès à KeyId fourni
400 AkvEndpointNotReachableFromNode : le point de terminaison AKV «{0} » n’est pas accessible à partir de SQL, sur le serveur « ».{1}
400 SecurityAzureKeyVaultInvalidKeyName : l’opération n’a pas pu être effectuée en raison d’un nom de clé de serveur non valide.
400 AdalGenericError : l’opération n’a pas pu être terminée, car une erreur Azure Active Directory a été rencontrée.
400 AdalServicePrincipalNotFound : l’opération n’a pas pu être terminée, car une erreur de principal de service introuvable dans la bibliothèque Azure Active Directory a été rencontrée.
400 AzureKeyVaultMalformedVaultUri : l’URI de Key Vault fourni n’est pas valide.
400 SecurityAzureKeyVaultGeoChainError : la création d’un composant secondaire (un processus appelé chaînage) n’est pas prise en charge lors de l’activation de Transparent Data Encryption à l’aide d’Azure Key Vault (BYOK).
400 PerDatabaseCMKDWNotSupported : la clé CMK au niveau de la base de données en préversion n’est pas prise en charge pour l’édition Datawarehouse.
404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable
404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.
404 ResourceNotFound : la ressource demandée est introuvable.
404 ServerKeyNotFound - la clé serveur demandée est introuvable sur l’abonnement actuel.
404 OperationIdNotFound : l’opération avec ID n’existe pas.
409 EncryptionProtectorChangeInProgress : impossible de mettre à jour le protecteur de clé de chiffrement de base de données alors que la modification du protecteur est déjà en cours
409 ServerKeyNameAlreadyExists : la clé de serveur existe déjà sur le serveur.
409 ServerKeyUriAlreadyExists : l’URI de clé de serveur existe déjà sur le serveur.
409 ServerKeyDoesNotExists - la clé du serveur n’existe pas.
409 AzureKeyVaultKeyNameNotFound : l’opération n’a pas pu être effectuée, car le nom de la clé Azure Key Vault n’existe pas.
409 AzureKeyVaultKeyInUse : la clé est actuellement utilisée par le serveur.
409 OperationCancelled : l’opération a été annulée par l’utilisateur.
409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource.
429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.
429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.
500 OperationTimedOut : l’opération a expiré et a été automatiquement restaurée. Réessayez l’opération.
503 AzureKeyVaultConnectionFailed : l’opération n’a pas pu être effectuée sur le serveur, car les tentatives de connexion à Azure Key Vault ont échoué
503 AzureKeyVaultGenericConnectionError : l’opération n’a pas pu être terminée, car une erreur s’est produite lors de la tentative de récupération des informations Key Vault .
503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.

Exemples

Update the encryption protector to key vault

Update the encryption protector to service managed

Update the encryption protector to key vault

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

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


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

/** Samples for ManagedInstanceEncryptionProtectors CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ManagedInstanceEncryptionProtectorCreateOrUpdateKeyVault.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().getManagedInstanceEncryptionProtectors().createOrUpdate(
            "sqlcrudtest-7398", "sqlcrudtest-4645", EncryptionProtectorName.CURRENT,
            new ManagedInstanceEncryptionProtectorInner().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/managedInstances/sqlcrudtest-4645/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/encryptionProtector",
  "kind": "azurekeyvault",
  "properties": {
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
    "serverKeyType": "AzureKeyVault",
    "autoRotationEnabled": false
  }
}

Status code:: 202

Update the encryption protector to service managed

Sample Request

HTTP
Java

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

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


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

/** Samples for ManagedInstanceEncryptionProtectors CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ManagedInstanceEncryptionProtectorCreateOrUpdateServiceManaged.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().getManagedInstanceEncryptionProtectors().createOrUpdate(
            "sqlcrudtest-7398", "sqlcrudtest-4645", EncryptionProtectorName.CURRENT,
            new ManagedInstanceEncryptionProtectorInner().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/managedInstances/sqlcrudtest-4645/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/encryptionProtector",
  "kind": "servicemanaged",
  "properties": {
    "serverKeyName": "ServiceManaged",
    "serverKeyType": "ServiceManaged"
  }
}

Status code:: 202

Définitions

Nom	Description
EncryptionProtectorName	Nom du protecteur de chiffrement à mettre à jour.
ManagedInstanceEncryptionProtector	Protecteur de chiffrement instance managé.
ServerKeyType	Type de protecteur de chiffrement comme « ServiceManaged », « AzureKeyVault ».

EncryptionProtectorName

Nom du protecteur de chiffrement à mettre à jour.

Nom	Type	Description
current	string

ManagedInstanceEncryptionProtector

Protecteur de chiffrement instance managé.

Nom	Type	Description
id	string	ID de la ressource
kind	string	Type de protecteur de chiffrement. Il s’agit des métadonnées utilisées pour l’expérience Portail Azure.
name	string	Nom de la ressource.
properties.autoRotationEnabled	boolean	Indicateur d’activation de la rotation automatique des clés. true ou false.
properties.serverKeyName	string	Nom de la clé de instance gérée.
properties.serverKeyType	ServerKeyType	Type de protecteur de chiffrement comme « ServiceManaged », « AzureKeyVault ».
properties.thumbprint	string	Empreinte numérique de la clé de serveur.
properties.uri	string	URI de la clé de serveur.
type	string	Type de ressource.

ServerKeyType

Type de protecteur de chiffrement comme « ServiceManaged », « AzureKeyVault ».

Nom	Type	Description
AzureKeyVault	string
ServiceManaged	string

Managed Instance Encryption Protectors - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Exemples

Update the encryption protector to key vault

Sample Request

Sample Response

Update the encryption protector to service managed

Sample Request

Sample Response

Définitions

EncryptionProtectorName

ManagedInstanceEncryptionProtector

ServerKeyType

Ressources supplémentaires