Managed Instance Encryption Protectors - Create Or Update

Service:
SQL Database
API Version:
2020-08-01-preview

Aktualizuje istniejącą ochronę szyfrowania.

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

Parametry identyfikatora URI

Name In Required Type Description
encryptionProtectorName
 path True

Nazwa ochrony szyfrowania, która ma zostać zaktualizowana.
managedInstanceName
 path True
  • string

Nazwa wystąpienia zarządzanego.
resourceGroupName
 path True
  • string

Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać za pomocą interfejsu API Azure Resource Manager lub portalu.
subscriptionId
 path True
  • string

Identyfikator subskrypcji, który identyfikuje subskrypcję platformy Azure.
api-version
 query True
  • string

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

Treść żądania

Name Required Type Description
properties.serverKeyType True

Typ ochrony szyfrowania, taki jak "servicemanaged", "AzureKeyVault".
properties.autoRotationEnabled
  • boolean

Flaga wyboru autorotacji kluczy. Wartość true lub false.
properties.serverKeyName
  • string

Nazwa klucza wystąpienia zarządzanego.

Odpowiedzi

Name Type Description
200 OK

Pomyślnie Zaktualizowano ochronę szyfrowania.
202 Accepted

Zaakceptowano
Other Status Codes

Odpowiedzi na błędy: * * _

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

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

  • 400 InvalidUpsertKeyType — zarządzane przez usługę klucze TDE 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 utworzenia 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 Azure Key Vault wygasł.

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

  • 400 KeyMaterialNotFoundOnRemoteServer — serwer zdalny nie ma dostępu do kluczowych materiałów użytych jako funkcja ochrony TDE.

  • 400 AzureKeyVaultMismatchError — w odpowiedzi HTTP znaleziono nieoczekiwany region Key Vault.

  • 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 AzureKeyVaultInvalidExpirationDate — nie można ukończyć operacji z powodu nieprawidłowej daty wygaśnięcia klucza Azure Key Vault.

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

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

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

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

  • 400 SecurityAzureKeyVaultGeoChainError — tworzenie pomocniczych elementów pomocniczych (proces nazywany łańcuchem) nie jest obsługiwane podczas włączania Transparent Data Encryption przy użyciu Azure Key Vault (BYOK).

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

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

  • 401 AzureKeyVaultMissingPermissions — na serwerze brakuje wymaganych uprawnień do Azure Key Vault.

  • 401 AdalGenericError — nie można ukończyć operacji, ponieważ Napotkano błąd Azure Active Directory.

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

  • 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera

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

  • 404 ResourceNotFound — nie znaleziono żądanego zasobu.

  • 404 ServerKeyNotFound — nie znaleziono żądanego klucza serwera w bieżącej subskrypcji.

  • 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 Azure Key Vault nie istnieje.

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

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

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

Przykłady

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=2020-08-01-preview
Request Body
{
  "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/managedInstances/sqlcrudtest-4645/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/encryptionProtector",
  "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/managedInstances/sqlcrudtest-4645/encryptionProtector/current?api-version=2020-08-01-preview
Request Body
{
  "properties": {
    "serverKeyType": "ServiceManaged",
    "serverKeyName": "ServiceManaged"
  }
}

Sample Response

Status code:
200 
{
  "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"
  }
}
Status code:
202

Definicje

EncryptionProtectorName

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

Ochrona szyfrowania wystąpienia zarządzanego.
ServerKeyType

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

EncryptionProtectorName

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

Name Type Description
current
  • string

ManagedInstanceEncryptionProtector

Ochrona szyfrowania wystąpienia zarządzanego.

Name Type Description
id
  • string

Identyfikator zasobu.
kind
  • string

Rodzaj ochrony szyfrowania. Jest to metadane używane dla Azure Portal środowiska.
name
  • string

Nazwa zasobu.
properties.autoRotationEnabled
  • boolean

Flaga wyboru autorotacji kluczy. Wartość true lub false.
properties.serverKeyName
  • string

Nazwa klucza wystąpienia zarządzanego.
properties.serverKeyType

Typ ochrony szyfrowania, taki jak "servicemanaged", "AzureKeyVault".
properties.thumbprint
  • string

Odcisk palca klucza serwera.
properties.uri
  • string

Identyfikator URI klucza serwera.
type
  • string

Typ zasobu.

ServerKeyType

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

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string