Udostępnij za pośrednictwem


Encryption Protectors - Create Or Update

Aktualizuje istniejącą ochronę szyfrowania.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
encryptionProtectorName
path True

EncryptionProtectorName

Nazwa funkcji ochrony szyfrowania, która ma zostać zaktualizowana.

resourceGroupName
path True

string

Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.

serverName
path True

string

Nazwa serwera.

subscriptionId
path True

string

Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.

api-version
query True

string

Wersja interfejsu API do użycia dla żądania.

Treść żądania

Nazwa Wymagane Typ Opis
properties.serverKeyType True

ServerKeyType

Typ ochrony szyfrowania, taki jak "ServiceManaged", "AzureKeyVault".

properties.autoRotationEnabled

boolean

Flaga automatycznego obracania kluczy. Prawda lub fałsz.

properties.serverKeyName

string

Nazwa klucza serwera.

Odpowiedzi

Nazwa Typ Opis
200 OK

EncryptionProtector

Pomyślnie zaktualizowano ochronę szyfrowania.

202 Accepted

Akceptowane

Nagłówki

Location: string

Other Status Codes

ErrorResponse

Odpowiedzi na błędy: ***

  • 400 ManagedInstanceStoppingOrStopped — operacja powodująca konflikt przesłana, gdy wystąpienie jest w stanie zatrzymania/zatrzymania

  • 400 ManagedInstanceStarting — operacja powodująca konflikt przesłana, gdy wystąpienie jest w stanie początkowym

  • 400 InvalidKeyName — podano nieprawidłową wartość dla nazwy klucza serwera.

  • 400 InvalidKeyType — typ klucza serwera tworzenia nie jest obsługiwany.

  • 400 InvalidUpsertKeyType — klucze TDE zarządzane przez usługę są zarządzane przez usługę. Klucze TDE zarządzane przez usługę nie obsługują tworzenia ani aktualizowania przez użytkownika.

  • 400 InvalidKeyUpsertRequest — żądanie tworzenia klucza serwera nie istnieje lub nie ma obiektu właściwości.

  • 400 InvalidEncryptionProtectorName — nazwa klucza ochrony szyfrowania nie jest obsługiwana.

  • 400 SecurityAdalPrincipalCertExpiredError — nie można ukończyć operacji, ponieważ certyfikat główny usługi Azure Key Vault wygasł.

  • 400 AkvHostNotResolvingFromNode — host AKV "{0}" nie jest rozpoznawany z bazy danych SQL na serwerze "{1}".

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel — podany identyfikator URI usługi Key Vault jest nieprawidłowy.

  • 400 MissingKeyVaultUriForRestore — identyfikator URI klucza usługi Azure Key Vault "{0}" jest wymagany do pomyślnego przywrócenia bazy danych "{1}" w obszarze serwera "{2}".

  • 400 AzureKeyVaultKeyUsedOnGeoPrimary — nie można ukończyć operacji, ponieważ nazwa klucza usługi Azure Key Vault {0} jest obecnie ustawiona jako funkcja ochrony szyfrowania w lokalizacji geograficznej podstawowej.

  • 400 KeyMaterialNotFoundOnRemoteServer — serwer zdalny nie ma dostępu do materiału klucza używanego jako funkcja ochrony TDE.

  • 400 PerDatabaseCMKAKVKeyMaterialMissingOnGeoSecondary — wszystkie bazy danych w replikacji geograficznej muszą zawierać ten sam materiał klucza co ochrona szyfrowania źródłowej bazy danych. Dodaj klucz "{0}" z tym samym materiałem klucza do docelowej bazy danych "{1}".

  • 400 AzureKeyVaultRsaKeyNotSupported — podany magazyn kluczy używa nieobsługiwanego rozmiaru klucza RSA lub typu klucza. Obsługiwany rozmiar klucza RSA to 2048 lub 3072, a typ klucza to RSA lub RSA-HSM.

  • 400 PerDatabaseCMKAKVKeyUriMissingOnGeoSecondary — po włączeniu automatycznej rotacji funkcji ochrony TDE na poziomie bazy danych zarówno źródłowe, jak i docelowe bazy danych muszą być połączone z tym samym magazynem kluczy. Dodaj klucz "{0}" (z tego samego magazynu kluczy, który jest połączony ze źródłową bazą danych) do docelowej bazy danych "{1}".

  • 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeysWithDatabaseName — podczas próby replikowania bazy danych skonfigurowanej za pomocą ochrony szyfrowania na poziomie bazy danych bieżące klucze używane przez podstawową bazę danych muszą zostać przekazane do pomocniczej bazy danych "{0}"

  • 400 ManagedInstanceNoConditionToMakeDatabaseAccessible — nie można ukończyć operacji, ponieważ nie ma wystarczających uprawnień do uruchamiania dostępnego przepływu pracy w wystąpieniu zarządzanym {0}.

  • 400 UmiMissingAkvPermissions — PrimaryUserAssignedIdentityId udostępniony przez użytkownika nie ma dostępu do podanego identyfikatora KeyId

  • 400 SameKeyUriNotFoundOnRemoteServer — serwer pomocniczy nie ma materiału klucza z tego samego magazynu kluczy, co funkcja ochrony szyfrowania serwera podstawowego z włączonym automatycznym rotacją klucza.

  • 400 SameKeyMaterialNotFoundOnRemoteServer — serwer pomocniczy nie ma klucza ochrony szyfrowania serwera podstawowego.

  • 400 SecurityAzureKeyVaultGeoChainError — tworzenie pomocniczej pomocniczej (procesu znanego jako łańcuch) nie jest obsługiwane podczas włączania funkcji Transparent Data Encryption przy użyciu usługi Azure Key Vault (BYOK).

  • 400 PerDatabaseCMKDWNotSupported — klucz CMK na poziomie bazy danych w wersji zapoznawczej nie jest obsługiwany w przypadku wersji datawarehouse.

  • 400 BlockSystemAssignedIdentityForCrossTenantCMK — klucz cmK między dzierżawami można skonfigurować tylko wtedy, gdy serwer jest skonfigurowany przy użyciu tożsamości zarządzanej przypisanej przez użytkownika. Zapoznaj się z https://aka.ms/sqltdebyokumi, aby skonfigurować tożsamość zarządzaną przypisaną przez użytkownika.

  • 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys — podczas próby replikowania bazy danych skonfigurowanej za pomocą ochrony szyfrowania na poziomie bazy danych bieżące klucze używane przez podstawową bazę danych muszą zostać przekazane do pomocniczej bazy danych.

  • 400 CannotDropDatabaseAKVError — {0} bazy danych na serwerze {1} nie można bezpiecznie usunąć, ponieważ jest szyfrowana przy użyciu klucza zarządzanego przez klienta, który nie jest już dostępny do wykonania ostatniej kopii zapasowej przed usunięciem. Przywróć dostęp do usługi Azure Key Vault na serwerze i ponownie zaktualizuj klucze, aby ta baza danych była dostępna, a następnie kontynuuj usuwanie. Aby uzyskać szczegółowe informacje, zobacz https://aka.ms/tdecmkrestorability

  • 400 CreateDatabaseAttemptedWithRotationInProgress — nie można wykonać operacji tworzenia bazy danych w tej chwili z powodu trwającej rotacji kluczy Transparent Data Encryption (TDE) na serwerze. Spróbuj ponownie wykonać operację później.

  • 400 AzureKeyVaultKeyDisabled — nie można ukończyć operacji na serwerze, ponieważ klucz usługi Azure Key Vault jest wyłączony.

  • 400 PerDatabaseCMKRestoreNotSupported — przywracanie bazy danych nie jest obsługiwane, gdy klucz zarządzania na poziomie bazy danych jest skonfigurowany w wersji zapoznawczej.

  • 400 AzureKeyVaultInvalidExpirationDate — nie można ukończyć operacji, ponieważ data wygaśnięcia klucza usługi Azure Key Vault jest nieprawidłowa.

  • 400 PerDatabaseCMKHSNotSupported — klucz CMK na poziomie bazy danych w wersji zapoznawczej nie jest obsługiwany w wersji hiperskala.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty — nie można ukończyć operacji, ponieważ identyfikator URI usługi Azure Key Vault ma wartość null lub jest pusty.

  • 400 CMKOperationNotAllowed — użytkownik próbował wykonać operację na serwerze, gdy serwer nie ma dostępu do usługi Azure Key Vault.

  • 400 AkvEndpointNotReachableFromNode — punkt końcowy usługi AKV "{0}" nie jest osiągalny z bazy danych SQL na serwerze "{1}".

  • 400 AzureKeyVaultNoServerIdentity — tożsamość serwera nie jest poprawnie skonfigurowana.

  • 400 AzureKeyVaultInvalidUri — nieprawidłowa odpowiedź z usługi Azure Key Vault. Użyj prawidłowego identyfikatora URI usługi Azure Key Vault.

  • 400 AzureKeyVaultMissingPermissions — serwer nie ma wymaganych uprawnień w usłudze Azure Key Vault.

  • 400 AzureKeyVaultKeyNameCurrentlyInUse — nie można ukończyć operacji, ponieważ nazwa klucza usługi Azure Key Vault {0} jest obecnie używana.

  • 400 AzureKeyVaultKeyThumbprintIsDifferent — nie można ukończyć operacji, ponieważ materiał klucza usługi Azure Key Vault różni się od bieżącego klucza ochrony szyfrowania.

  • 400 SecurityAzureKeyVaultInvalidKeyName — nie można ukończyć operacji z powodu nieprawidłowej nazwy klucza serwera.

  • 400 OldGenerationOfAKVKeyBeingUsedError — używanie starej wersji klucza AKV jako funkcji ochrony TDE jest niedozwolone. Użyj najnowszej wersji klucza usługi AKV jako funkcji ochrony szyfrowania

  • 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase — tożsamość cmK bazy danych nie jest skonfigurowana w docelowej bazie danych.

  • 400 AdalGenericError — nie można ukończyć operacji, ponieważ wystąpił błąd usługi Azure Active Directory.

  • 400 AdalServicePrincipalNotFound — nie można ukończyć operacji, ponieważ napotkano błąd jednostki usługi biblioteki usługi Azure Active Directory.

  • 400 AzureKeyVaultMalformedVaultUri — podany identyfikator URI usługi Key Vault jest nieprawidłowy.

  • 404 ServerNotInSubscriptionResourceGroup — określony serwer nie istnieje w określonej grupie zasobów i subskrypcji.

  • 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera

  • 404 ResourceNotFound — żądany zasób nie został znaleziony.

  • 404 ServerKeyNotFound — żądany klucz serwera nie został znaleziony w bieżącej subskrypcji.

  • 404 OperationIdNotFound — operacja o identyfikatorze nie istnieje.

  • 409 EncryptionProtectorChangeInProgress — nie można zaktualizować ochrony klucza szyfrowania bazy danych, podczas gdy zmiana ochrony jest już w toku

  • 409 ServerKeyNameAlreadyExists — klucz serwera już istnieje na serwerze.

  • 409 ServerKeyUriAlreadyExists — identyfikator URI klucza serwera już istnieje na serwerze.

  • 409 ServerKeyDoesNotExists — klucz serwera nie istnieje.

  • 409 AzureKeyVaultKeyNameNotFound — nie można ukończyć operacji, ponieważ nazwa klucza usługi Azure Key Vault nie istnieje.

  • 409 AzureKeyVaultKeyInUse — klucz jest obecnie używany przez serwer.

  • 409 CannotCancelOperation — operacja zarządzania jest w stanie, którego nie można anulować.

  • 409 OperationCancelled — operacja została anulowana przez użytkownika.

  • 409 Operacja przerwana — nie można ukończyć operacji na zasobie, ponieważ została przerwana przez inną operację na tym samym zasobie.

  • 429 SubscriptionTooManyCreateUpdateRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby.

  • 429 SubscriptionTooManyRequests — żądania wykraczające poza maksymalną liczbę żądań, które mogą być przetwarzane przez dostępne zasoby.

  • 500 OperationTimedOut — upłynął limit czasu operacji i automatycznie wycofano. Ponów próbę wykonania operacji.

  • 503 AzureKeyVaultConnectionFailed — nie można ukończyć operacji na serwerze, ponieważ próby nawiązania połączenia z usługą Azure Key Vault zakończyły się niepowodzeniem

  • 503 AzureKeyVaultGenericConnectionError — nie można ukończyć operacji, ponieważ wystąpił błąd podczas próby pobrania informacji usługi Key Vault.

  • 503 TooManyRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby.

Przykłady

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

Update the encryption protector to key vault

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
EncryptionProtector

Ochrona szyfrowania serwera.

EncryptionProtectorName

Nazwa funkcji ochrony szyfrowania, która ma zostać zaktualizowana.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

ServerKeyType

Typ ochrony szyfrowania, taki jak "ServiceManaged", "AzureKeyVault".

EncryptionProtector

Ochrona szyfrowania serwera.

Nazwa Typ Opis
id

string

Identyfikator zasobu.

kind

string

Rodzaj ochrony szyfrowania. Są to metadane używane w środowisku witryny Azure Portal.

location

string

Lokalizacja zasobu.

name

string

Nazwa zasobu.

properties.autoRotationEnabled

boolean

Flaga automatycznego obracania kluczy. Prawda lub fałsz.

properties.serverKeyName

string

Nazwa klucza serwera.

properties.serverKeyType

ServerKeyType

Typ ochrony szyfrowania, taki jak "ServiceManaged", "AzureKeyVault".

properties.subregion

string

Podregion ochrony szyfrowania.

properties.thumbprint

string

Odcisk palca klucza serwera.

properties.uri

string

Identyfikator URI klucza serwera.

type

string

Typ zasobu.

EncryptionProtectorName

Nazwa funkcji ochrony szyfrowania, która ma zostać zaktualizowana.

Wartość Opis
current

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

ServerKeyType

Typ ochrony szyfrowania, taki jak "ServiceManaged", "AzureKeyVault".

Wartość Opis
AzureKeyVault
ServiceManaged