Managed Instance Encryption Protectors - Create Or Update

Aggiorna una protezione di crittografia esistente.

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

Parametri dell'URI

Name In Required Type Description
encryptionProtectorName
path True

Nome della protezione di crittografia da aggiornare.

managedInstanceName
path True
  • string

Nome dell'istanza gestita.

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.

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

Name Required Type Description
properties.serverKeyType True

Tipo di protezione della crittografia come 'ServiceManaged', 'AzureKeyVault'.

properties.autoRotationEnabled
  • boolean

Contrassegno di consenso esplicito per la rotazione automatica delle chiavi. True o false.

properties.serverKeyName
  • string

Nome della chiave dell'istanza gestita.

Risposte

Name Type Description
200 OK

È stato aggiornato correttamente la protezione della crittografia.

202 Accepted

Accettato

Other Status Codes

Risposte agli errori: **

  • 400 InvalidKeyName: viene 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 sono gestite dal servizio. Le chiavi TDE gestite dal servizio non supportano La creazione o l'aggiornamento dall'utente.

  • 400 InvalidKeyUpsertRequest: la richiesta di chiave del server di creazione 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 azure Key Vault è scaduto.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel - L'URI fornito Key Vault non è valido.

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

  • 400 AzureKeyVaultMismatchError - Area di Key Vault imprevista trovata nella risposta http.

  • 400 AzureKeyVaultRsaKeyNotSupported: l'insieme di credenziali delle chiavi fornito usa dimensioni chiave RSA o tipo di chiave non supportato. 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 SecurityAzureKeyVaultUrlNullOrEmpty - Impossibile completare l'operazione perché l'URI di Azure Key Vault è null o vuoto.

  • 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 manca delle autorizzazioni necessarie per l'Key Vault di Azure.

  • 400 SecurityAzureKeyVaultInvalidKeyName- Impossibile completare l'operazione a causa di un nome chiave 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 Azure Active Directory entità servizio libreria.

  • 400 AzureKeyVaultMalformedVaultUri: l'uri Key Vault fornito non è valido.

  • 400 SecurityAzureKeyVaultGeoChainError - Creazione di un processo secondario (un processo noto come concatenamento) non è supportato quando si abilita Transparent Data Encryption tramite Azure Key Vault (BYOK).

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

  • 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 AzureKeyVaultKeyKeyNameNotFound- Impossibile completare l'operazione perché il nome della chiave di Azure Key Vault non esiste.

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

  • 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 informazioni Key Vault .

Esempio

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

Definizioni

EncryptionProtectorName

Nome della protezione di crittografia da aggiornare.

ManagedInstanceEncryptionProtector

Protezione della crittografia dell'istanza gestita.

ServerKeyType

Tipo di protezione della crittografia come 'ServiceManaged', 'AzureKeyVault'.

EncryptionProtectorName

Nome della protezione di crittografia da aggiornare.

Name Type Description
current
  • string

ManagedInstanceEncryptionProtector

Protezione della crittografia dell'istanza gestita.

Name Type Description
id
  • string

ID risorsa.

kind
  • string

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

name
  • string

Nome risorsa.

properties.autoRotationEnabled
  • boolean

Contrassegno di consenso esplicito per la rotazione automatica delle chiavi. True o false.

properties.serverKeyName
  • string

Nome della chiave dell'istanza gestita.

properties.serverKeyType

Tipo di protezione della crittografia come 'ServiceManaged', 'AzureKeyVault'.

properties.thumbprint
  • string

Identificazione personale della chiave del server.

properties.uri
  • string

URI della chiave del server.

type
  • string

Tipo di risorsa.

ServerKeyType

Tipo di protezione della crittografia come 'ServiceManaged', 'AzureKeyVault'.

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string