Freigeben über


Encryption Protectors - Create Or Update

Aktualisiert eine vorhandene Verschlüsselungsschutzkomponente.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
encryptionProtectorName
path True

EncryptionProtectorName

Der Name der Verschlüsselungsschutzkomponente, die aktualisiert werden soll.

resourceGroupName
path True

string

Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.

serverName
path True

string

Der Name des Servers.

subscriptionId
path True

string

Die Abonnement-ID, die ein Azure-Abonnement identifiziert.

api-version
query True

string

Die 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

Kennzeichen für die automatische Drehung der Schlüsseldrehung. Entweder wahr oder falsch.

properties.serverKeyName

string

Der Name des Serverschlüssels.

Antworten

Name Typ Beschreibung
200 OK

EncryptionProtector

Die Verschlüsselungsschutzkomponente wurde erfolgreich aktualisiert.

202 Accepted

Angenommen

Header

Location: string

Other Status Codes

ErrorResponse

Fehlerantworten: ***

  • 400 ManagedInstanceStoppingOrStopped – Konfliktierender Vorgang, der während der Instanz beendet/beendet wird

  • 400 ManagedInstanceStarting – Konfliktierender Vorgang, der während der Instanz im Startzustand liegt

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

  • 400 InvalidKeyType – Der Serverschlüsseltyp 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 nicht das Erstellen oder Aktualisieren durch den Benutzer.

  • 400 InvalidKeyUpsertRequest – Die Anforderung zum Erstellen von Serverschlüsseln 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, da das Azure Key Vault-Prinzipalzertifikat abgelaufen ist.

  • 400 AkvHostNotResolvingFromNode - AKV-Host '{0}' ist nicht aus SQL, auf server '{1}'.

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

  • 400 MissingKeyVaultUriForRestore – Azure Key Vault-Schlüssel-URI '{0}' ist erforderlich, um die Datenbank '{1}' unter Server '{2}' erfolgreich wiederherzustellen.

  • 400 AzureKeyVaultKeyUsedOnGeoPrimary – Der Vorgang konnte nicht abgeschlossen werden, da der Name des Azure Key Vault-Schlüssels {0} derzeit als Verschlüsselungsschutzkomponente für geo-primary festgelegt ist.

  • 400 KeyMaterialNotFoundOnRemoteServer – Remoteserver hat keinen Zugriff auf Schlüsselmaterial, das als TDE-Schutz verwendet wird.

  • 400 PerDatabaseCMKAKVKeyMaterialMissingOnGeoSecondary – Alle Datenbanken in der Georeplikation müssen dasselbe Schlüsselmaterial wie die Verschlüsselungsschutzkomponente der Quelldatenbank enthalten. Fügen Sie den Schlüssel "{0}" mit demselben Schlüsselmaterial zur Zieldatenbank '{1}' hinzu.

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

  • 400 PerDatabaseCMKAKVKeyUriMissingOnGeoSecondary – Wenn die automatische Drehung der TDE-Schutzkomponente auf Datenbankebene aktiviert ist, müssen sowohl Quell- als auch Zieldatenbanken mit demselben Schlüsseltresor verbunden sein. Fügen Sie der Zieldatenbank "{0}" (aus demselben Schlüsseltresor, der mit der Quelldatenbank verbunden ist) den Schlüssel "{1}" hinzu.

  • 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeysWithDatabaseName - Beim Versuch, eine datenbank zu replizieren, die mit verschlüsselungsschutz auf Datenbankebene konfiguriert ist, müssen die aktuellen Schlüssel, die von der primären Datenbank verwendet werden, an die sekundäre Datenbank '{0}' übergeben werden'

  • 400 ManagedInstanceNoConditionToMakeDatabaseAccessible – Der Vorgang konnte nicht abgeschlossen werden, da keine ausreichenden Berechtigungen zum Starten des barrierefreien Workflows für verwaltete Instanz {0}vorhanden sind.

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

  • 400 SameKeyUriNotFoundOnRemoteServer – Der sekundäre Server verfügt nicht über das Schlüsselmaterial aus demselben Schlüsseltresor wie die Verschlüsselungsschutzvorrichtung des primären Servers mit aktivierter Automatischdrehung des Schlüssels.

  • 400 SameKeyMaterialNotFoundOnRemoteServer – Sekundärer Server verfügt nicht über das Schlüsselmaterial der Verschlüsselungsschutzkomponente des primären Servers.

  • 400 SecurityAzureKeyVaultGeoChainError – Das Erstellen einer sekundären (als Verkettung bezeichneter Prozess) wird beim Aktivieren der transparenten Datenverschlüsselung mit Azure Key Vault (BYOK) nicht unterstützt.

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

  • 400 BlockSystemAssignedIdentityForCrossTenantCMK – Mandantenübergreifendes CMK kann nur konfiguriert werden, wenn der Server mit einer vom Benutzer zugewiesenen verwalteten Identität konfiguriert ist. Informationen zum Konfigurieren der vom Benutzer zugewiesenen verwalteten Identität finden Sie unter https://aka.ms/sqltdebyokumi.

  • 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys – Beim Versuch, eine Datenbank zu replizieren, die mit verschlüsselungsschutz auf Datenbankebene konfiguriert ist, müssen die aktuellen Schlüssel, die von der primären Datenbank verwendet werden, an die sekundäre Datenbank übergeben werden.

  • 400 CannotDropDatabaseAKVError – Die Datenbank {0} auf dem Server {1} kann nicht sicher gelöscht werden, da sie mit einem vom Kunden verwalteten Schlüssel verschlüsselt ist, auf den die letzte Sicherung vor dem Ablegen nicht mehr zugegriffen werden kann. Stellen Sie den Azure Key Vault-Zugriff auf dem Server wieder her, und aktualisieren Sie die Schlüssel, um diese Datenbank barrierefrei zu machen, und fahren Sie dann mit dem Ablegen fort. Ausführliche Informationen finden Sie unter https://aka.ms/tdecmkrestorability

  • 400 CreateDatabaseAttemptedWithRotationInProgress – Der Datenbankerstellungsvorgang kann derzeit aufgrund der fortlaufenden TDE-Schlüsseldrehung (Transparent Data Encryption) auf dem Server nicht ausgeführt werden. Versuchen Sie es später erneut.

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

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

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

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

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

  • 400 CMKOperationNotAllowed – Der Benutzer hat versucht, einen Vorgang auf dem Server auszuführen, wenn der Server keinen Azure Key Vault-Zugriff hat.

  • 400 AkvEndpointNotReachableFromNode - AKV-Endpunkt '{0}' ist nicht erreichbar von SQL, auf server '{1}'.

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

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

  • 400 AzureKeyVaultMissingPermissions – Der Server fehlt die erforderlichen Berechtigungen für den Azure Key Vault.

  • 400 AzureKeyVaultKeyNameCurrentlyInUse – Der Vorgang konnte nicht abgeschlossen werden, da der Azure Key Vault Key-Name {0} derzeit verwendet wird.

  • 400 AzureKeyThumbprintIsDifferent – Der Vorgang konnte nicht abgeschlossen werden, da sich das Material des Azure Key Vault-Schlüssels von dem aktuellen Verschlüsselungsschutzschlüssel unterscheidet.

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

  • 400 OldGenerationOfAKVKeyBeingUsedError – Die Verwendung einer alten Version des AKV-Schlüssels als TDE-Schutz ist nicht zulässig. Verwenden Sie die neueste Version des AKV-Schlüssels als Verschlüsselungsschutzkomponente.

  • 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase – Pro Datenbank-CMK-Identität nicht für die Zieldatenbank eingerichtet.

  • 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 Azure Active Directory-Bibliotheksdienstprinzipal nicht gefunden wurde.

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

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

  • 404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden.

  • 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 Schutzschutzänderung bereits ausgeführt 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 Key-Name nicht vorhanden ist.

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

  • 409 CannotCancelOperation – Der Verwaltungsvorgang befindet sich in einem Zustand, der nicht abgebrochen werden kann.

  • 409 OperationCancelled – Der Vorgang wurde vom Benutzer abgebrochen.

  • 409 OperationInterrupted – Der Vorgang für die Ressource konnte nicht abgeschlossen werden, weil er durch einen anderen Vorgang in derselben Ressource unterbrochen wurde.

  • 429 SubscriptionTooManyCreateUpdateRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

  • 429 SubscriptionTooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

  • 500 OperationTimedOut – Timeout des Vorgangs und automatisches Zurücksetzen. Versuchen Sie den Vorgang erneut.

  • 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, weil beim Versuch, Key Vault-Informationen abzurufen, ein Fehler aufgetreten ist.

  • 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, 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

Beispielanforderung

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

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

Beispiel für eine Antwort

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

Update the encryption protector to service managed

Beispielanforderung

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

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
EncryptionProtector

Der Serververschlüsselungsschutz.

EncryptionProtectorName

Der Name der Verschlüsselungsschutzkomponente, die aktualisiert werden soll.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Fehlerantwort

ServerKeyType

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

EncryptionProtector

Der Serververschlüsselungsschutz.

Name Typ Beschreibung
id

string

Ressourcen-ID.

kind

string

Art der Verschlüsselungsschutzkomponente. Dies sind Metadaten, die für die Azure-Portaloberfläche verwendet werden.

location

string

Ressourcenspeicherort.

name

string

Ressourcenname.

properties.autoRotationEnabled

boolean

Kennzeichen für die automatische Drehung der Schlüsseldrehung. Entweder wahr oder falsch.

properties.serverKeyName

string

Der Name des Serverschlüssels.

properties.serverKeyType

ServerKeyType

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

properties.subregion

string

Unterbereich der Verschlüsselungsschutzkomponente.

properties.thumbprint

string

Fingerabdruck des Serverschlüssels.

properties.uri

string

Der URI des Serverschlüssels.

type

string

Ressourcentyp.

EncryptionProtectorName

Der Name der Verschlüsselungsschutzkomponente, die aktualisiert werden soll.

Wert Beschreibung
current

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

ServerKeyType

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

Wert Beschreibung
AzureKeyVault
ServiceManaged