Encryption Protectors - Create Or Update

Aktualizace existující ochranu šifrování.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
encryptionProtectorName
path True

EncryptionProtectorName

Název ochrany šifrování, který se má aktualizovat.

resourceGroupName
path True

string

Název skupiny prostředků, která prostředek obsahuje. Tuto hodnotu můžete získat z rozhraní API Resource Manager Azure nebo z portálu.

serverName
path True

string

Název serveru.

subscriptionId
path True

string

ID předplatného, které identifikuje předplatné Azure.

api-version
query True

string

Verze rozhraní API, která se má použít pro požadavek.

Text požadavku

Name Vyžadováno Typ Description
properties.serverKeyType True

ServerKeyType

Typ ochrany šifrování, jako je ServiceManaged, AzureKeyVault.

properties.autoRotationEnabled

boolean

Příznak výslovného souhlasu s obměnou klávesou. Buď true, nebo false.

properties.serverKeyName

string

Název klíče serveru.

Odpovědi

Name Typ Description
200 OK

EncryptionProtector

Ochrana šifrování se úspěšně aktualizovala.

202 Accepted

Přijato

Other Status Codes

Chybové odpovědi: ***

  • 400 InvalidKeyName – Pro název klíče serveru byla zadána neplatná hodnota.

  • 400 InvalidKeyType – Typ klíče pro vytvoření serveru není podporován.

  • 400 InvalidUpsertKeyType – klíče transparentního šifrování dat spravované službou spravuje služba. Klíče transparentního šifrování dat spravované službou nepodporují vytvoření nebo aktualizaci uživatelem.

  • 400 InvalidKeyUpsertRequest – požadavek na vytvoření klíče serveru neexistuje nebo nemá žádný objekt properties.

  • 400 InvalidEncryptionProtectorName – název klíče ochrany šifrování se nepodporuje.

  • 400 SecurityAdalPrincipalCertExpiredError – Operaci nebylo možné dokončit, protože vypršela platnost certifikátu objektu zabezpečení azure Key Vault.

  • 400 AkvHostNotResolvingFromNode – hostitel{0} AKV není možné přeložit z SQL na serveru{1} .

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel – zadaný identifikátor URI Key Vault není platný.

  • 400 KeyMaterialNotFoundOnRemoteServer – Vzdálený server nemá přístup ke klíčům, které se používají jako ochrana transparentním šifrováním dat.

  • 400 AzureKeyVaultRsaKeyNotSupported – Zadaný trezor klíčů používá nepodporovanou velikost klíče RSA nebo typ klíče. Podporovaná velikost klíče RSA je 2048 nebo 3072 a typ klíče je RSA nebo RSA-HSM.

  • 400 AzureKeyVaultKeyDisabled – Operaci nebylo možné na serveru dokončit, protože klíč azure Key Vault je zakázaný.

  • 400 AzureKeyVaultInvalidExpirationDate – Operaci nelze dokončit, protože datum vypršení platnosti klíče azure Key Vault je neplatné.

  • 400 SameKeyUriNotFoundOnRemoteServer – Sekundární server nemá materiál klíčů ze stejného trezoru klíčů jako ochrana šifrování primárního serveru s povolenou automatickou obměnou klíče.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty – Operaci nešlo dokončit, protože identifikátor URI Azure Key Vault je null nebo prázdný.

  • 400 SameKeyMaterialNotFoundOnRemoteServer – Sekundární server nemá klíč ochrany šifrování primárního serveru.

  • 400 PerDatabaseCMKRestoreNotSupported – Obnovení databáze se nepodporuje, pokud je klíč CMK na úrovni databáze nakonfigurovaný ve verzi Preview.

  • 400 AzureKeyVaultNoServerIdentity – Identita serveru není správně nakonfigurovaná.

  • 400 PerDatabaseCMKHSNotSupported – Cmk na úrovni databáze ve verzi Preview není podporován pro edici Hyperscale.

  • 400 AzureKeyVaultInvalidUri – neplatná odpověď z Azure Key Vault. Použijte platný identifikátor URI azure Key Vault.

  • 400 AzureKeyVaultMissingPermissions – serveru chybí požadovaná oprávnění k Key Vault Azure.

  • 400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId poskytnuté uživatelem nemá přístup k zadanému id klíče.

  • 400 AkvEndpointNotReachableFromNode – koncový bod{0} AKV není dostupný z SQL na serveru{1} .

  • 400 SecurityAzureKeyVaultInvalidKeyName – Operaci nebylo možné dokončit kvůli neplatnému názvu klíče serveru.

  • 400 AdalGenericError – Operaci nebylo možné dokončit, protože došlo k chybě Azure Active Directory.

  • 400 AdalServicePrincipalNotFound – Operaci nebylo možné dokončit, protože došlo k chybě Instanční objekt knihovny Azure Active Directory se nenašel.

  • 400 AzureKeyVaultMalformedVaultUri – zadaný identifikátor URI Key Vault není platný.

  • 400 SecurityAzureKeyVaultGeoChainError – Při povolování transparentního šifrování dat pomocí Azure Key Vault (BYOK) se nepodporuje vytvoření sekundárního serveru (proces označovaný jako řetězení).

  • 400 PerDatabaseCMKDWNotSupported – Edici Datawarehouse se nepodporuje cmk na úrovni databáze ve verzi Preview.

  • 404 SubscriptionDoesNotHaveServer – Požadovaný server se nenašel.

  • 404 ServerNotInSubscriptionResourceGroup – zadaný server v zadané skupině prostředků a předplatném neexistuje.

  • 404 ResourceNotFound – Požadovaný prostředek se nenašel.

  • 404 ServerKeyNotFound – Požadovaný klíč serveru nebyl v aktuálním předplatném nalezen.

  • 404 OperationIdNotFound – operace s ID neexistuje.

  • 409 EncryptionProtectorChangeInProgress – Nejde aktualizovat ochranu šifrovacího klíče databáze, když už probíhá změna ochrany

  • 409 ServerKeyNameAlreadyExists – klíč serveru už na serveru existuje.

  • 409 ServerKeyUriAlreadyExists – identifikátor URI klíče serveru už na serveru existuje.

  • 409 ServerKeyDoesNotExists – klíč serveru neexistuje.

  • 409 AzureKeyVaultKeyNameNotFound – Operaci nebylo možné dokončit, protože název klíče azure Key Vault neexistuje.

  • 409 AzureKeyVaultKeyInUse – klíč aktuálně používá server.

  • 409 OperationCancelled – operace byla zrušena uživatelem.

  • 409 OperationInterrupted – Operaci s prostředkem nebylo možné dokončit, protože byla přerušena jinou operací se stejným prostředkem.

  • 429 SubscriptionTooManyCreateUpdateRequests – požadavky nad maximální počet požadavků, které je možné zpracovat dostupnými prostředky.

  • 429 SubscriptionTooManyRequests – požadavky nad rámec maximálního počtu požadavků, které je možné zpracovat dostupnými prostředky.

  • 500 OperationTimedOut – časový limit operace vypršel a automaticky se vrátila zpět. Opakujte operaci.

  • 503 AzureKeyVaultConnectionFailed – Operaci se na serveru nepodařilo dokončit, protože pokusy o připojení k Azure Key Vault selhaly.

  • 503 AzureKeyVaultGenericConnectionError – Operaci nebylo možné dokončit, protože při pokusu o načtení Key Vault informací došlo k chybě.

  • 503 TooManyRequests – požadavky nad rámec maximálního počtu požadavků, které je možné zpracovat dostupnými prostředky.

Příklady

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

Update the encryption protector to key vault

Ukázkový požadavek

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

Ukázková odpověď

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

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
EncryptionProtector

Ochrana šifrování serveru.

EncryptionProtectorName

Název ochrany šifrování, který se má aktualizovat.

ServerKeyType

Typ ochrany šifrování, jako je ServiceManaged, AzureKeyVault.

EncryptionProtector

Ochrana šifrování serveru.

Name Typ Description
id

string

ID prostředku.

kind

string

Druh ochrany šifrování. Jedná se o metadata používaná pro Azure Portal prostředí.

location

string

Umístění prostředku.

name

string

Název prostředku.

properties.autoRotationEnabled

boolean

Příznak výslovného souhlasu s obměnou klávesou. Buď true, nebo false.

properties.serverKeyName

string

Název klíče serveru.

properties.serverKeyType

ServerKeyType

Typ ochrany šifrování, jako je ServiceManaged, AzureKeyVault.

properties.subregion

string

Podoblast ochrany šifrování

properties.thumbprint

string

Kryptografický otisk klíče serveru.

properties.uri

string

Identifikátor URI klíče serveru.

type

string

Typ prostředku.

EncryptionProtectorName

Název ochrany šifrování, který se má aktualizovat.

Name Typ Description
current

string

ServerKeyType

Typ ochrany šifrování, jako je ServiceManaged, AzureKeyVault.

Name Typ Description
AzureKeyVault

string

ServiceManaged

string