Encryption Protectors - Create Or Update

  • Referenz
Service:
SQL Database
API Version:
2021-11-01

Updates eine vorhandene Verschlüsselungsschutzvorrichtung.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
encryptionProtectorName
 path True

EncryptionProtectorName

Der Name der zu aktualisierenden Verschlüsselungsschutzvorrichtung.
resourceGroupName
 path True

string

Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serverName
 path True

string

Name des Servers
subscriptionId
 path True

string

Abonnement-ID für ein Azure-Abonnement.
api-version
 query True

string

API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name Erforderlich Typ Beschreibung
properties.serverKeyType True

ServerKeyType

Der Verschlüsselungsschutztyp wie "ServiceManaged", "AzureKeyVault".
properties.autoRotationEnabled

boolean

Aktivierungsflag für die automatische Schlüsselrotation. Entweder true oder false.
properties.serverKeyName

string

Der Name des Serverschlüssels.

Antworten

Name Typ Beschreibung
200 OK

EncryptionProtector

Die Verschlüsselungsschutzvorrichtung wurde erfolgreich aktualisiert.
202 Accepted

Akzeptiert
Other Status Codes

Fehlerantworten: ***

  • 400 InvalidKeyName: Für den Serverschlüsselnamen wurde ein ungültiger Wert angegeben.

  • 400 InvalidKeyType: Der Typ "Serverschlüssel erstellen" wird nicht unterstützt.

  • 400 InvalidUpsertKeyType: Vom Dienst verwaltete TDE-Schlüssel werden vom Dienst verwaltet. Vom Dienst verwaltete TDE-Schlüssel unterstützen das Erstellen oder Aktualisieren durch den Benutzer nicht.

  • 400 InvalidKeyUpsertRequest: Die Anforderung zum Erstellen des Serverschlüssels ist nicht vorhanden oder weist kein Eigenschaftenobjekt auf.

  • 400 InvalidEncryptionProtectorName: Der Name des Verschlüsselungsschutzschlüssels wird nicht unterstützt.

  • 400 SecurityAdalPrincipalCertExpiredError: Der Vorgang konnte nicht abgeschlossen werden, weil das Azure Key Vault-Prinzipalzertifikat abgelaufen ist.

  • 400 AkvHostNotResolvingFromNode: DER AKV-Host "{0}" kann von SQL auf dem Server "{1}" nicht aufgelöst werden.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel: Der bereitgestellte Key Vault URI ist ungültig.

  • 400 KeyMaterialNotFoundOnRemoteServer: Der Remoteserver hat keinen Zugriff auf Schlüsselmaterial, das als TDE-Schutzvorrichtung verwendet wird.

  • 400 AzureKeyVaultRsaKeyNotSupported: Der bereitgestellte Schlüsseltresor verwendet nicht unterstützte RSA-Schlüsselgröße oder -Schlüsseltyp. Die unterstützte RSA-Schlüsselgröße ist 2048 oder 3072, und der Schlüsseltyp ist RSA oder RSA-HSM.

  • 400 AzureKeyVaultKeyDisabled: Der Vorgang konnte auf dem Server nicht abgeschlossen werden, da der Azure Key Vault-Schlüssel deaktiviert ist.

  • 400 AzureKeyVaultInvalidExpirationDate: Der Vorgang konnte nicht abgeschlossen werden, da das Ablaufdatum des Azure Key Vault Schlüssels ungültig ist.

  • 400 SameKeyUriNotFoundOnRemoteServer: Auf dem sekundären Server wird nicht das Schlüsselmaterial aus demselben Schlüsseltresor wie die Verschlüsselungsschutzvorrichtung des primären Servers mit aktivierter automatischer Schlüsselrotation verwendet.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty: Der Vorgang konnte nicht abgeschlossen werden, da der Azure Key Vault-URI NULL oder leer ist.

  • 400 SameKeyMaterialNotFoundOnRemoteServer: Der sekundäre Server verfügt nicht über das Schlüsselmaterial der Verschlüsselungsschutzvorrichtung des primären Servers.

  • 400 PerDatabaseCMKRestoreNotSupported: Die Datenbankwiederherstellung wird nicht unterstützt, wenn CMK auf Datenbankebene in der Vorschau konfiguriert ist.

  • 400 AzureKeyVaultNoServerIdentity: Die Serveridentität ist nicht ordnungsgemäß konfiguriert.

  • 400 PerDatabaseCMKHSNotSupported: CMK auf Datenbankebene in der Vorschau wird für die Hyperscale-Edition nicht unterstützt.

  • 400 AzureKeyVaultInvalidUri: Eine ungültige Antwort von Azure Key Vault. Verwenden Sie einen gültigen Azure Key Vault-URI.

  • 400 AzureKeyVaultMissingPermissions: Dem Server fehlen die erforderlichen Berechtigungen für die Azure Key Vault.

  • 400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId, die vom Benutzer bereitgestellt wird, hat keinen Zugriff auf die bereitgestellte KeyId.

  • 400 AkvEndpointNotReachableFromNode: DER AKV-Endpunkt "{0}" ist von SQL auf dem Server "{1}" nicht erreichbar.

  • 400 SecurityAzureKeyVaultInvalidKeyName: Der Vorgang konnte aufgrund eines ungültigen Serverschlüsselnamens nicht abgeschlossen werden.

  • 400 AdalGenericError: Der Vorgang konnte nicht abgeschlossen werden, weil ein Azure Active Directory-Fehler aufgetreten ist.

  • 400 AdalServicePrincipalNotFound: Der Vorgang konnte nicht abgeschlossen werden, weil ein Fehler vom Dienstprinzipal der Azure Active Directory-Bibliothek nicht gefunden wurde.

  • 400 AzureKeyVaultMalformedVaultUri: Der bereitgestellte Key Vault URI ist ungültig.

  • 400 SecurityAzureKeyVaultGeoChainError: Das Erstellen einer sekundären sekundären Instanz (ein Prozess, der als Verkettung bezeichnet wird) wird beim Aktivieren von Transparent Data Encryption mit Azure Key Vault (BYOK) nicht unterstützt.

  • 400 PerDatabaseCMKDWNotSupported: CMK auf Datenbankebene in der Vorschau wird für die Datawarehouse-Edition nicht unterstützt.

  • 404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden.

  • 404 ServerNotInSubscriptionResourceGroup: Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden.

  • 404 ResourceNotFound: Die angeforderte Ressource wurde nicht gefunden.

  • 404 ServerKeyNotFound: Der angeforderte Serverschlüssel wurde im aktuellen Abonnement nicht gefunden.

  • 404 OperationIdNotFound: Der Vorgang mit der ID ist nicht vorhanden.

  • 409 EncryptionProtectorChangeInProgress: Datenbankverschlüsselungsschlüsselschutz kann nicht aktualisiert werden, während die Schutzvorrichtung bereits geändert wird

  • 409 ServerKeyNameAlreadyExists: Der Serverschlüssel ist bereits auf dem Server vorhanden.

  • 409 ServerKeyUriAlreadyExists: Der Serverschlüssel-URI ist bereits auf dem Server vorhanden.

  • 409 ServerKeyDoesNotExists: Der Serverschlüssel ist nicht vorhanden.

  • 409 AzureKeyVaultKeyNameNotFound: Der Vorgang konnte nicht abgeschlossen werden, da der Azure Key Vault Schlüsselname nicht vorhanden ist.

  • 409 AzureKeyVaultKeyInUse: Der Schlüssel wird derzeit vom Server verwendet.

  • 409 OperationCancelled: Der Vorgang wurde vom Benutzer abgebrochen.

  • 409 OperationInterrupted: Der Vorgang für die Ressource konnte nicht abgeschlossen werden, da er durch einen anderen Vorgang für dieselbe Ressource unterbrochen wurde.

  • 429 SubscriptionTooManyCreateUpdateRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.

  • 429 SubscriptionTooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.

  • 500 OperationTimedOut: Timeout des Vorgangs und automatisches Rollback. Wiederholen Sie den Vorgang.

  • 503 AzureKeyVaultConnectionFailed: Der Vorgang konnte auf dem Server nicht abgeschlossen werden, da versuche, eine Verbindung mit Azure Key Vault herzustellen, fehlgeschlagen sind.

  • 503 AzureKeyVaultGenericConnectionError: Der Vorgang konnte nicht abgeschlossen werden, da beim Versuch, Key Vault Informationen abzurufen, ein Fehler aufgetreten ist.

  • 503 TooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.

Beispiele

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/servers/sqlcrudtest-4645/encryptionProtector/current?api-version=2021-11-01

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

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

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

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

Definitionen

Name Beschreibung
EncryptionProtector

Die Schutzvorrichtung für die Serververschlüsselung.
EncryptionProtectorName

Der Name der zu aktualisierenden Verschlüsselungsschutzvorrichtung.
ServerKeyType

Der Verschlüsselungsschutztyp wie "ServiceManaged", "AzureKeyVault".

EncryptionProtector

Die Schutzvorrichtung für die Serververschlüsselung.

Name Typ Beschreibung
id

string

Ressourcen-ID
kind

string

Art der Verschlüsselungsschutzvorrichtung. Dies sind Metadaten, die für die Azure-Portal-Benutzeroberfläche verwendet werden.
location

string

Ressourcenspeicherort
name

string

Name der Ressource.
properties.autoRotationEnabled

boolean

Aktivierungsflag für die automatische Schlüsselrotation. Entweder true oder false.
properties.serverKeyName

string

Der Name des Serverschlüssels.
properties.serverKeyType

ServerKeyType

Der Verschlüsselungsschutztyp wie "ServiceManaged", "AzureKeyVault".
properties.subregion

string

Unterbereich der Verschlüsselungsschutzvorrichtung.
properties.thumbprint

string

Fingerabdruck des Serverschlüssels.
properties.uri

string

Der URI des Serverschlüssels.
type

string

Der Ressourcentyp.

EncryptionProtectorName

Der Name der zu aktualisierenden Verschlüsselungsschutzvorrichtung.

Name Typ Beschreibung
current

string

ServerKeyType

Der Verschlüsselungsschutztyp wie "ServiceManaged", "AzureKeyVault".

Name Typ Beschreibung
AzureKeyVault

string

ServiceManaged

string