Managed Instance Encryption Protectors - Create Or Update

Met à 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-02-01-preview

Paramètres URI

Name In Required Type Description
encryptionProtectorName
path True

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

Name Required Type Description
properties.serverKeyType True

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

properties.autoRotationEnabled
  • boolean

Indicateur d’option de rotation automatique de clé. true ou false.

properties.serverKeyName
  • string

Nom de la clé d’instance managée.

Réponses

Name Type Description
200 OK

Mise à jour réussie du protecteur de chiffrement.

202 Accepted

Acceptée

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 de création 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 clé de serveur de création n’existe pas ou n’a pas d’objet de propriétés.

  • 400 InvalidEncryptionProtectorName : le nom de la clé de 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 SecurityInvalidAzureKeyVaultRecoveryLevel : l’URI de 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 AzureKeyVaultMismatchError - Région Key Vault inattendue trouvée dans la réponse http.

  • 400 AzureKeyVaultRsaKeyNotSupported : le coffre de clés fourni utilise la taille ou le type de clé RSA 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 effectuée, car la date d’expiration de la clé Azure Key Vault n’est pas valide.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty : l’opération n’a pas pu être effectuée, car l’URI d’Azure Key Vault est null ou vide.

  • 400 AzureKeyVaultNoServerIdentity : l’identité du serveur n’est pas correctement configurée.

  • 400 AzureKeyVaultInvalidUri : réponse non valide d’Azure Key Vault. Utilisez un URI azure Key Vault valide.

  • 400 AzureKeyVaultMissingPermissions : le serveur ne dispose pas des autorisations requises sur le Key Vault Azure.

  • 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 effectué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 Azure Active Directory principal du service de bibliothèque introuvable a été rencontrée.

  • 400 AzureKeyVaultMalformedVaultUri : l’URI de Key Vault fourni n’est pas valide.

  • 400 SecurityAzureKeyVaultGeoChainError : la création d’un serveur secondaire secondaire (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).

  • 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.

  • 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 clé Azure Key Vault n’existe pas.

  • 409 AzureKeyVaultKeyInUse : la clé est actuellement utilisée par le serveur.

  • 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 effectuée, car une erreur s’est produite lors de la tentative de récupération des informations Key Vault .

Exemples

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

Update the encryption protector to key vault

Sample Request

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-02-01-preview

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

Sample Response

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

Update the encryption protector to service managed

Sample Request

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-02-01-preview

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

Sample Response

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

Définitions

EncryptionProtectorName

Nom du protecteur de chiffrement à mettre à jour.

ManagedInstanceEncryptionProtector

Protecteur de chiffrement d’instance managée.

ServerKeyType

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

EncryptionProtectorName

Nom du protecteur de chiffrement à mettre à jour.

Name Type Description
current
  • string

ManagedInstanceEncryptionProtector

Protecteur de chiffrement d’instance managée.

Name 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’option de rotation automatique de clé. true ou false.

properties.serverKeyName
  • string

Nom de la clé d’instance managée.

properties.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 ».

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string