Encryption Protectors - Create Or Update

Referens

Tjänst:: SQL Database

API-version:: 2021-11-01

Uppdateringar ett befintligt krypteringsskydd.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
encryptionProtectorName	path	True	EncryptionProtectorName	Namnet på krypteringsskyddet som ska uppdateras.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string	Prenumerations-ID:t som identifierar en Azure-prenumeration.
api-version	query	True	string	DEN API-version som ska användas för begäran.

Begärandetext

Name	Obligatorisk	Typ	Description
properties.serverKeyType	True	ServerKeyType	Krypteringsskyddstypen som "ServiceManaged", "AzureKeyVault".
properties.autoRotationEnabled		boolean	Opt-in-flagga för automatisk rotation av nycklar. Antingen sant eller falskt.
properties.serverKeyName		string	Namnet på servernyckeln.

Svar

Name	Typ	Description
200 OK	EncryptionProtector	Krypteringsskyddet har uppdaterats.
202 Accepted		Har godkänts
Other Status Codes		Felsvar: *** 400 InvalidKeyName – Ett ogiltigt värde angavs för servernyckelnamnet. 400 InvalidKeyType – Nyckeltypen skapa server stöds inte. 400 InvalidUpsertKeyType – Tjänsthanterade TDE-nycklar hanteras av tjänsten. Tjänsthanterade TDE-nycklar stöder inte skapa eller uppdatera av användaren. 400 InvalidKeyUpsertRequest – begäran om att skapa servernyckeln finns inte eller har inget egenskapsobjekt. 400 InvalidEncryptionProtectorName – nyckelnamnet för krypteringsskydd stöds inte. 400 SecurityAdalPrincipalCertExpiredError – Åtgärden kunde inte slutföras eftersom Azure Key Vault huvudcertifikat har upphört att gälla. 400 AkvHostNotResolvingFromNode – AKV-värden{0} kan inte matchas från SQL på servern .{1} 400 SecurityInvalidAzureKeyVaultRecoveryLevel – den angivna Key Vault uri är inte giltig. 400 KeyMaterialNotFoundOnRemoteServer – Fjärrservern har inte åtkomst till nyckelmaterial som används som TDE-skydd. 400 AzureKeyVaultRsaKeyNotSupported – Det angivna nyckelvalvet använder RSA-nyckelstorlek eller nyckeltyp som inte stöds. RSA-nyckelstorleken som stöds är 2048 eller 3072 och nyckeltypen är RSA eller RSA-HSM. 400 AzureKeyVaultKeyDisabled – Det gick inte att slutföra åtgärden på servern eftersom Azure Key Vault-nyckeln är inaktiverad. 400 AzureKeyVaultInvalidExpirationDate – Åtgärden kunde inte slutföras eftersom Azure Key Vault nyckelns förfallodatum är ogiltigt. 400 SameKeyUriNotFoundOnRemoteServer – Den sekundära servern har inte nyckelmaterialet från samma nyckelvalv som den primära serverns krypteringsskydd med automatisk nyckelrotation aktiverat. 400 SecurityAzureKeyVaultUrlNullOrEmpty – Åtgärden kunde inte slutföras eftersom Azure Key Vault Uri är null eller tom. 400 SameKeyMaterialNotFoundOnRemoteServer – Den sekundära servern har inte nyckelmaterialet för den primära serverns krypteringsskydd. 400 PerDatabaseCMKRestoreNotSupported – Databasåterställning stöds inte när CMK på databasnivå konfigureras i förhandsversion. 400 AzureKeyVaultNoServerIdentity – serveridentiteten är inte korrekt konfigurerad. 400 PerDatabaseCMKHSNotSupported – CMK på databasnivå i förhandsversionen stöds inte för Hyperskala Edition. 400 AzureKeyVaultInvalidUri – ett ogiltigt svar från Azure Key Vault. Använd en giltig URI för Azure Key Vault. 400 AzureKeyVaultMissingPermissions – Servern saknar nödvändiga behörigheter för Azure Key Vault. 400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId som tillhandahålls av användaren har inte åtkomst till KeyId 400 AkvEndpointNotReachableFromNode – AKV-slutpunkten{0} kan inte nås från SQL på servern{1} . 400 SecurityAzureKeyVaultInvalidKeyName – Åtgärden kunde inte slutföras på grund av ett ogiltigt servernyckelnamn. 400 AdalGenericError – Det gick inte att slutföra åtgärden eftersom ett Azure Active Directory-fel påträffades. 400 AdalServicePrincipalNotFound – Det gick inte att slutföra åtgärden eftersom ett azure Active Directory-bibliotekstjänsthuvudnamn inte hittades. 400 AzureKeyVaultMalformedVaultUri – den angivna Key Vault uri är inte giltig. 400 SecurityAzureKeyVaultGeoChainError – Det går inte att skapa sekundär sekundär (en process som kallas länkning) när transparent datakryptering aktiveras med Hjälp av Azure Key Vault (BYOK). 400 PerDatabaseCMKDWNotSupported – CMK på databasnivå i förhandsversionen stöds inte för Datawarehouse Edition. 404 SubscriptionDoesNotHaveServer – den begärda servern hittades inte 404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen. 404 ResourceNotFound – Den begärda resursen hittades inte. 404 ServerKeyNotFound – Den begärda servernyckeln hittades inte i den aktuella prenumerationen. 404 OperationIdNotFound – Åtgärden med ID finns inte. 409 EncryptionProtectorChangeInProgress – Det går inte att uppdatera nyckelskyddet för databaskryptering medan skyddsändring redan pågår 409 ServerKeyNameAlreadyExists – servernyckeln finns redan på servern. 409 ServerKeyUriAlreadyExists – servernyckelns URI finns redan på servern. 409 ServerKeyDoesNotExists – servernyckeln finns inte. 409 AzureKeyVaultKeyNameNotFound – Åtgärden kunde inte slutföras eftersom Azure Key Vault Nyckelnamn inte finns. 409 AzureKeyVaultKeyInUse – Nyckeln används för närvarande av servern. 409 OperationCancelled – Åtgärden har avbrutits av användaren. 409 Åtgärd avbröts – Det gick inte att slutföra åtgärden på resursen eftersom den avbröts av en annan åtgärd på samma resurs. 429 SubscriptionTooManyCreateUpdateRequests – begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser. 429 SubscriptionTooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser. 500 OperationTimedOut – Tidsgränsen för åtgärden uppnåddes och återställdes automatiskt. Försök att utföra åtgärden igen. 503 AzureKeyVaultConnectionFailed – Det gick inte att slutföra åtgärden på servern eftersom försök att ansluta till Azure Key Vault misslyckades 503 AzureKeyVaultGenericConnectionError – Det gick inte att slutföra åtgärden eftersom ett fel påträffades när Key Vault information skulle hämtas. 503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Name

Typ

Description

200 OK

EncryptionProtector

Krypteringsskyddet har uppdaterats.

202 Accepted

Har godkänts

Other Status Codes

Felsvar: ***

400 InvalidKeyName – Ett ogiltigt värde angavs för servernyckelnamnet.
400 InvalidKeyType – Nyckeltypen skapa server stöds inte.
400 InvalidUpsertKeyType – Tjänsthanterade TDE-nycklar hanteras av tjänsten. Tjänsthanterade TDE-nycklar stöder inte skapa eller uppdatera av användaren.
400 InvalidKeyUpsertRequest – begäran om att skapa servernyckeln finns inte eller har inget egenskapsobjekt.
400 InvalidEncryptionProtectorName – nyckelnamnet för krypteringsskydd stöds inte.
400 SecurityAdalPrincipalCertExpiredError – Åtgärden kunde inte slutföras eftersom Azure Key Vault huvudcertifikat har upphört att gälla.
400 AkvHostNotResolvingFromNode – AKV-värden{0} kan inte matchas från SQL på servern .{1}
400 SecurityInvalidAzureKeyVaultRecoveryLevel – den angivna Key Vault uri är inte giltig.
400 KeyMaterialNotFoundOnRemoteServer – Fjärrservern har inte åtkomst till nyckelmaterial som används som TDE-skydd.
400 AzureKeyVaultRsaKeyNotSupported – Det angivna nyckelvalvet använder RSA-nyckelstorlek eller nyckeltyp som inte stöds. RSA-nyckelstorleken som stöds är 2048 eller 3072 och nyckeltypen är RSA eller RSA-HSM.
400 AzureKeyVaultKeyDisabled – Det gick inte att slutföra åtgärden på servern eftersom Azure Key Vault-nyckeln är inaktiverad.
400 AzureKeyVaultInvalidExpirationDate – Åtgärden kunde inte slutföras eftersom Azure Key Vault nyckelns förfallodatum är ogiltigt.
400 SameKeyUriNotFoundOnRemoteServer – Den sekundära servern har inte nyckelmaterialet från samma nyckelvalv som den primära serverns krypteringsskydd med automatisk nyckelrotation aktiverat.
400 SecurityAzureKeyVaultUrlNullOrEmpty – Åtgärden kunde inte slutföras eftersom Azure Key Vault Uri är null eller tom.
400 SameKeyMaterialNotFoundOnRemoteServer – Den sekundära servern har inte nyckelmaterialet för den primära serverns krypteringsskydd.
400 PerDatabaseCMKRestoreNotSupported – Databasåterställning stöds inte när CMK på databasnivå konfigureras i förhandsversion.
400 AzureKeyVaultNoServerIdentity – serveridentiteten är inte korrekt konfigurerad.
400 PerDatabaseCMKHSNotSupported – CMK på databasnivå i förhandsversionen stöds inte för Hyperskala Edition.
400 AzureKeyVaultInvalidUri – ett ogiltigt svar från Azure Key Vault. Använd en giltig URI för Azure Key Vault.
400 AzureKeyVaultMissingPermissions – Servern saknar nödvändiga behörigheter för Azure Key Vault.
400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId som tillhandahålls av användaren har inte åtkomst till KeyId
400 AkvEndpointNotReachableFromNode – AKV-slutpunkten{0} kan inte nås från SQL på servern{1} .
400 SecurityAzureKeyVaultInvalidKeyName – Åtgärden kunde inte slutföras på grund av ett ogiltigt servernyckelnamn.
400 AdalGenericError – Det gick inte att slutföra åtgärden eftersom ett Azure Active Directory-fel påträffades.
400 AdalServicePrincipalNotFound – Det gick inte att slutföra åtgärden eftersom ett azure Active Directory-bibliotekstjänsthuvudnamn inte hittades.
400 AzureKeyVaultMalformedVaultUri – den angivna Key Vault uri är inte giltig.
400 SecurityAzureKeyVaultGeoChainError – Det går inte att skapa sekundär sekundär (en process som kallas länkning) när transparent datakryptering aktiveras med Hjälp av Azure Key Vault (BYOK).
400 PerDatabaseCMKDWNotSupported – CMK på databasnivå i förhandsversionen stöds inte för Datawarehouse Edition.
404 SubscriptionDoesNotHaveServer – den begärda servern hittades inte
404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen.
404 ResourceNotFound – Den begärda resursen hittades inte.
404 ServerKeyNotFound – Den begärda servernyckeln hittades inte i den aktuella prenumerationen.
404 OperationIdNotFound – Åtgärden med ID finns inte.
409 EncryptionProtectorChangeInProgress – Det går inte att uppdatera nyckelskyddet för databaskryptering medan skyddsändring redan pågår
409 ServerKeyNameAlreadyExists – servernyckeln finns redan på servern.
409 ServerKeyUriAlreadyExists – servernyckelns URI finns redan på servern.
409 ServerKeyDoesNotExists – servernyckeln finns inte.
409 AzureKeyVaultKeyNameNotFound – Åtgärden kunde inte slutföras eftersom Azure Key Vault Nyckelnamn inte finns.
409 AzureKeyVaultKeyInUse – Nyckeln används för närvarande av servern.
409 OperationCancelled – Åtgärden har avbrutits av användaren.
409 Åtgärd avbröts – Det gick inte att slutföra åtgärden på resursen eftersom den avbröts av en annan åtgärd på samma resurs.
429 SubscriptionTooManyCreateUpdateRequests – begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.
429 SubscriptionTooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.
500 OperationTimedOut – Tidsgränsen för åtgärden uppnåddes och återställdes automatiskt. Försök att utföra åtgärden igen.
503 AzureKeyVaultConnectionFailed – Det gick inte att slutföra åtgärden på servern eftersom försök att ansluta till Azure Key Vault misslyckades
503 AzureKeyVaultGenericConnectionError – Det gick inte att slutföra åtgärden eftersom ett fel påträffades när Key Vault information skulle hämtas.
503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Exempel

Update the encryption protector to key vault

Update the encryption protector to service managed

Update the encryption protector to key vault

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


import com.azure.resourcemanager.sql.fluent.models.EncryptionProtectorInner;
import com.azure.resourcemanager.sql.models.EncryptionProtectorName;
import com.azure.resourcemanager.sql.models.ServerKeyType;

/**
 * Samples for EncryptionProtectors CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * EncryptionProtectorCreateOrUpdateKeyVault.json
     */
    /**
     * Sample code: Update the encryption protector to key vault.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateTheEncryptionProtectorToKeyVault(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getEncryptionProtectors().createOrUpdate("sqlcrudtest-7398",
            "sqlcrudtest-4645", EncryptionProtectorName.CURRENT,
            new EncryptionProtectorInner().withServerKeyName("fakeTokenPlaceholder")
                .withServerKeyType(ServerKeyType.AZURE_KEY_VAULT).withAutoRotationEnabled(false),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exempelsvar

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

Statuskod:: 202

Update the encryption protector to service managed

Exempelbegäran

HTTP
Java

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


import com.azure.resourcemanager.sql.fluent.models.EncryptionProtectorInner;
import com.azure.resourcemanager.sql.models.EncryptionProtectorName;
import com.azure.resourcemanager.sql.models.ServerKeyType;

/**
 * Samples for EncryptionProtectors CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * EncryptionProtectorCreateOrUpdateServiceManaged.json
     */
    /**
     * Sample code: Update the encryption protector to service managed.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateTheEncryptionProtectorToServiceManaged(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getEncryptionProtectors().createOrUpdate("sqlcrudtest-7398",
            "sqlcrudtest-4645", EncryptionProtectorName.CURRENT, new EncryptionProtectorInner()
                .withServerKeyName("fakeTokenPlaceholder").withServerKeyType(ServerKeyType.SERVICE_MANAGED),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exempelsvar

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

Statuskod:: 202

Definitioner

Name	Description
EncryptionProtector	Skydd mot serverkryptering.
EncryptionProtectorName	Namnet på krypteringsskyddet som ska uppdateras.
ServerKeyType	Krypteringsskyddstypen som "ServiceManaged", "AzureKeyVault".

EncryptionProtector

Skydd mot serverkryptering.

Name	Typ	Description
id	string	Resurs-ID.
kind	string	Typ av krypteringsskydd. Det här är metadata som används för Azure Portal upplevelse.
location	string	Resursplats.
name	string	Resursnamn.
properties.autoRotationEnabled	boolean	Opt-in-flagga för automatisk rotation av nycklar. Antingen sant eller falskt.
properties.serverKeyName	string	Namnet på servernyckeln.
properties.serverKeyType	ServerKeyType	Krypteringsskyddstypen som "ServiceManaged", "AzureKeyVault".
properties.subregion	string	Underregion för krypteringsskydd.
properties.thumbprint	string	Tumavtryck för servernyckeln.
properties.uri	string	URI:n för servernyckeln.
type	string	Resurstyp.

EncryptionProtectorName

Namnet på krypteringsskyddet som ska uppdateras.

Name	Typ	Description
current	string

ServerKeyType

Krypteringsskyddstypen som "ServiceManaged", "AzureKeyVault".

Name	Typ	Description
AzureKeyVault	string
ServiceManaged	string

Dela via

Encryption Protectors - Create Or Update

URI-parametrar

Begärandetext

Svar

Exempel

Update the encryption protector to key vault

Exempelbegäran

Exempelsvar

Update the encryption protector to service managed

Exempelbegäran

Exempelsvar

Definitioner

EncryptionProtector

EncryptionProtectorName

ServerKeyType

Ytterligare resurser