Encryption Protectors - Create Or Update

Tjänst:: SQL Database

API-version:: 2023-08-01

Uppdaterar ett befintligt krypteringsskydd.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/encryptionProtector/current?api-version=2023-08-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	Det prenumerations-ID 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		Accepterad Sidhuvuden Location: string
Other Status Codes	ErrorResponse	Felsvar: *** 400 ManagedInstanceStoppingOrS toppad – Konfliktåtgärd som skickas när instansen är i stopptillstånd 400 ManagedInstanceStarting – Konfliktåtgärd som skickas när instansen är i starttillstånd 400 InvalidKeyName – Ett ogiltigt värde angavs för servernyckelnamnet. 400 InvalidKeyType – typen skapa servernyckel 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-huvudcertifikatet har upphört att gälla. 400 AkvHostNotResolvingFromNode – AKV-värden{0}kan inte matchas från SQL, på serverns{1}. 400 SecurityInvalidAzureKeyVaultRecoveryLevel – Den angivna Key Vault-URI:n är inte giltig. 400 MissingKeyVaultUriForRestore – Azure Key Vault-nyckel-URI{0}krävs för att återställa databasen{1}under servern{2}. 400 AzureKeyVaultKeyUsedOnGeoPrimary – Åtgärden kunde inte slutföras eftersom Azure Key Vault-nyckelnamnet {0} för närvarande har angetts som krypteringsskydd på geo-primärt. 400 KeyMaterialNotFoundOnRemoteServer – Fjärrservern har inte åtkomst till nyckelmaterial som används som TDE-skydd. 400 PerDatabaseCMKAKVKeyMaterialMissingOnGeoSecondary – Alla databaser i geo-replikering måste innehålla samma nyckelmaterial som källdatabasens krypteringsskydd. Lägg till nyckeln{0}med samma nyckelmaterial i måldatabasen{1}. 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 PerDatabaseCMKAKVKeyUriMissingOnGeoSecondary – När den automatiska rotationen av TDE-skydd på databasnivå är aktiverad måste både käll- och måldatabaser vara anslutna till samma nyckelvalv. Lägg till nyckeln{0}(från samma nyckelvalv som är anslutet till källdatabasen) till måldatabasen{1}. 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeysWithDatabaseName – När du försöker replikera en databas som konfigurerats med krypteringsskydd på databasnivå måste de aktuella nycklarna som används av den primära databasen skickas till den sekundära databasen{0} 400 ManagedInstanceNoConditionToMakeDatabaseAccessible – Åtgärden kunde inte slutföras eftersom det inte finns tillräckliga behörigheter för att starta ett tillgängligt arbetsflöde på den hanterade instansen {0}. 400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId som tillhandahålls av användaren har inte åtkomst till KeyId som tillhandahålls 400 SameKeyUriNotFoundOnRemoteServer – Sekundär server har inte nyckelmaterialet från samma nyckelvalv som den primära serverns krypteringsskydd med automatisk rotation aktiverad. 400 SameKeyMaterialNotFoundOnRemoteServer – sekundär server har inte nyckelmaterialet för den primära serverns krypteringsskydd. 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. 400 BlockSystemAssignedIdentityForCrossTenantCMK – CMK för flera klientorganisationer kan bara konfigureras när servern har konfigurerats med en användartilldelad hanterad identitet. Se https://aka.ms/sqltdebyokumi för att konfigurera användartilldelad hanterad identitet. 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys – När du försöker replikera en databas som konfigurerats med krypteringsskydd på databasnivå måste de aktuella nycklar som används av den primära skickas till den sekundära databasen. 400 CannotDropDatabaseAKVError – Databasen {0} på servern {1} inte kan tas bort på ett säkert sätt eftersom den är krypterad med en kundhanterad nyckel som inte längre är tillgänglig för att ta den sista säkerhetskopian innan den släpps. Återställ Azure Key Vault-åtkomst på servern och återställ nycklarna för att göra databasen tillgänglig och fortsätt sedan med släppet. Mer information finns i https://aka.ms/tdecmkrestorability 400 CreateDatabaseAttemptedWithRotationInProgress – Åtgärden skapa databas kan inte utföras just nu på grund av pågående transparent datakryptering (TDE) nyckelrotation på servern. Försök igen senare. 400 AzureKeyVaultKeyDisabled – Det gick inte att slutföra åtgärden på servern eftersom Azure Key Vault-nyckeln är inaktiverad. 400 PerDatabaseCMKRestoreNotSupported – Databasåterställning stöds inte när CMK på databasnivå konfigureras i förhandsversionen. 400 AzureKeyVaultInvalidExpirationDate – Det gick inte att slutföra åtgärden eftersom förfallodatumet för Azure Key Vault-nyckeln är ogiltigt. 400 PerDatabaseCMKHSNotSupported – CMK på databasnivå i förhandsversionen stöds inte för Hyperskala-utgåvan. 400 SecurityAzureKeyVaultUrlNullOrEmpty – Det gick inte att slutföra åtgärden eftersom Azure Key Vault-URI:n är null eller tom. 400 CMKOperationNotAllowed – Användaren försökte utföra en åtgärd på servern när servern inte hade Åtkomst till Azure Key Vault. 400 AkvEndpointNotReachableFromNode – AKV-slutpunkten{0}kan inte nås från SQL, på serverns{1}. 400 AzureKeyVaultNoServerIdentity – serveridentiteten är inte korrekt konfigurerad. 400 AzureKeyVaultInvalidUri – ett ogiltigt svar från Azure Key Vault. Använd en giltig Azure Key Vault-URI. 400 AzureKeyVaultMissingPermissions – Servern saknar nödvändiga behörigheter i Azure Key Vault. 400 AzureKeyVaultKeyNameCurrentlyInUse – Åtgärden kunde inte slutföras eftersom Azure Key Vault-nyckelnamnet {0} används för närvarande. 400 AzureKeyVaultKeyThumbprintIsDifferent – Åtgärden kunde inte slutföras eftersom Nyckelmaterialet för Azure Key Vault skiljer sig från den aktuella krypteringsskyddsnyckeln. 400 SecurityAzureKeyVaultInvalidKeyName – Åtgärden kunde inte slutföras på grund av ett ogiltigt servernyckelnamn. 400 OldGenerationOfAKVKeyBeingUsedError – Det är inte tillåtet att använda en gammal version av AKV-nyckeln som TDE-skydd. Använd den senaste versionen av AKV-nyckeln som krypteringsskydd 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase – CMK-identitet per databas som inte har konfigurerats på måldatabasen. 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:n är inte giltig. 404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen. 404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte 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 – Det gick inte att slutföra åtgärden eftersom Azure Key Vault-nyckelnamnet inte finns. 409 AzureKeyVaultKeyInUse – Nyckeln används för närvarande av servern. 409 CannotCancelOperation – hanteringsåtgärden är i ett tillstånd som inte kan avbrytas. 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 maxbegä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 igen. 503 AzureKeyVaultConnectionFailed – Det gick inte att slutföra åtgärden på servern eftersom det inte gick att ansluta till Azure Key Vault 503 AzureKeyVaultGenericConnectionError – Det gick inte att slutföra åtgärden eftersom ett fel uppstod vid försök att hämta Key Vault-information . 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

Accepterad

Sidhuvuden

Location: string

Other Status Codes

ErrorResponse

Felsvar: ***

400 ManagedInstanceStoppingOrS toppad – Konfliktåtgärd som skickas när instansen är i stopptillstånd
400 ManagedInstanceStarting – Konfliktåtgärd som skickas när instansen är i starttillstånd
400 InvalidKeyName – Ett ogiltigt värde angavs för servernyckelnamnet.
400 InvalidKeyType – typen skapa servernyckel 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-huvudcertifikatet har upphört att gälla.
400 AkvHostNotResolvingFromNode – AKV-värden{0}kan inte matchas från SQL, på serverns{1}.
400 SecurityInvalidAzureKeyVaultRecoveryLevel – Den angivna Key Vault-URI:n är inte giltig.
400 MissingKeyVaultUriForRestore – Azure Key Vault-nyckel-URI{0}krävs för att återställa databasen{1}under servern{2}.
400 AzureKeyVaultKeyUsedOnGeoPrimary – Åtgärden kunde inte slutföras eftersom Azure Key Vault-nyckelnamnet {0} för närvarande har angetts som krypteringsskydd på geo-primärt.
400 KeyMaterialNotFoundOnRemoteServer – Fjärrservern har inte åtkomst till nyckelmaterial som används som TDE-skydd.
400 PerDatabaseCMKAKVKeyMaterialMissingOnGeoSecondary – Alla databaser i geo-replikering måste innehålla samma nyckelmaterial som källdatabasens krypteringsskydd. Lägg till nyckeln{0}med samma nyckelmaterial i måldatabasen{1}.
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 PerDatabaseCMKAKVKeyUriMissingOnGeoSecondary – När den automatiska rotationen av TDE-skydd på databasnivå är aktiverad måste både käll- och måldatabaser vara anslutna till samma nyckelvalv. Lägg till nyckeln{0}(från samma nyckelvalv som är anslutet till källdatabasen) till måldatabasen{1}.
400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeysWithDatabaseName – När du försöker replikera en databas som konfigurerats med krypteringsskydd på databasnivå måste de aktuella nycklarna som används av den primära databasen skickas till den sekundära databasen{0}
400 ManagedInstanceNoConditionToMakeDatabaseAccessible – Åtgärden kunde inte slutföras eftersom det inte finns tillräckliga behörigheter för att starta ett tillgängligt arbetsflöde på den hanterade instansen {0}.
400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId som tillhandahålls av användaren har inte åtkomst till KeyId som tillhandahålls
400 SameKeyUriNotFoundOnRemoteServer – Sekundär server har inte nyckelmaterialet från samma nyckelvalv som den primära serverns krypteringsskydd med automatisk rotation aktiverad.
400 SameKeyMaterialNotFoundOnRemoteServer – sekundär server har inte nyckelmaterialet för den primära serverns krypteringsskydd.
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.
400 BlockSystemAssignedIdentityForCrossTenantCMK – CMK för flera klientorganisationer kan bara konfigureras när servern har konfigurerats med en användartilldelad hanterad identitet. Se https://aka.ms/sqltdebyokumi för att konfigurera användartilldelad hanterad identitet.
400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys – När du försöker replikera en databas som konfigurerats med krypteringsskydd på databasnivå måste de aktuella nycklar som används av den primära skickas till den sekundära databasen.
400 CannotDropDatabaseAKVError – Databasen {0} på servern {1} inte kan tas bort på ett säkert sätt eftersom den är krypterad med en kundhanterad nyckel som inte längre är tillgänglig för att ta den sista säkerhetskopian innan den släpps. Återställ Azure Key Vault-åtkomst på servern och återställ nycklarna för att göra databasen tillgänglig och fortsätt sedan med släppet. Mer information finns i https://aka.ms/tdecmkrestorability
400 CreateDatabaseAttemptedWithRotationInProgress – Åtgärden skapa databas kan inte utföras just nu på grund av pågående transparent datakryptering (TDE) nyckelrotation på servern. Försök igen senare.
400 AzureKeyVaultKeyDisabled – Det gick inte att slutföra åtgärden på servern eftersom Azure Key Vault-nyckeln är inaktiverad.
400 PerDatabaseCMKRestoreNotSupported – Databasåterställning stöds inte när CMK på databasnivå konfigureras i förhandsversionen.
400 AzureKeyVaultInvalidExpirationDate – Det gick inte att slutföra åtgärden eftersom förfallodatumet för Azure Key Vault-nyckeln är ogiltigt.
400 PerDatabaseCMKHSNotSupported – CMK på databasnivå i förhandsversionen stöds inte för Hyperskala-utgåvan.
400 SecurityAzureKeyVaultUrlNullOrEmpty – Det gick inte att slutföra åtgärden eftersom Azure Key Vault-URI:n är null eller tom.
400 CMKOperationNotAllowed – Användaren försökte utföra en åtgärd på servern när servern inte hade Åtkomst till Azure Key Vault.
400 AkvEndpointNotReachableFromNode – AKV-slutpunkten{0}kan inte nås från SQL, på serverns{1}.
400 AzureKeyVaultNoServerIdentity – serveridentiteten är inte korrekt konfigurerad.
400 AzureKeyVaultInvalidUri – ett ogiltigt svar från Azure Key Vault. Använd en giltig Azure Key Vault-URI.
400 AzureKeyVaultMissingPermissions – Servern saknar nödvändiga behörigheter i Azure Key Vault.
400 AzureKeyVaultKeyNameCurrentlyInUse – Åtgärden kunde inte slutföras eftersom Azure Key Vault-nyckelnamnet {0} används för närvarande.
400 AzureKeyVaultKeyThumbprintIsDifferent – Åtgärden kunde inte slutföras eftersom Nyckelmaterialet för Azure Key Vault skiljer sig från den aktuella krypteringsskyddsnyckeln.
400 SecurityAzureKeyVaultInvalidKeyName – Åtgärden kunde inte slutföras på grund av ett ogiltigt servernyckelnamn.
400 OldGenerationOfAKVKeyBeingUsedError – Det är inte tillåtet att använda en gammal version av AKV-nyckeln som TDE-skydd. Använd den senaste versionen av AKV-nyckeln som krypteringsskydd
400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase – CMK-identitet per databas som inte har konfigurerats på måldatabasen.
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:n är inte giltig.
404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen.
404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte
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 – Det gick inte att slutföra åtgärden eftersom Azure Key Vault-nyckelnamnet inte finns.
409 AzureKeyVaultKeyInUse – Nyckeln används för närvarande av servern.
409 CannotCancelOperation – hanteringsåtgärden är i ett tillstånd som inte kan avbrytas.
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 maxbegä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 igen.
503 AzureKeyVaultConnectionFailed – Det gick inte att slutföra åtgärden på servern eftersom det inte gick att ansluta till Azure Key Vault
503 AzureKeyVaultGenericConnectionError – Det gick inte att slutföra åtgärden eftersom ett fel uppstod vid försök att hämta Key Vault-information .
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=2023-08-01

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/EncryptionProtectorCreateOrUpdateKeyVault.json
// this example is just showing the usage of "EncryptionProtectors_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string serverName = "sqlcrudtest-4645";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this EncryptionProtectorResource
EncryptionProtectorCollection collection = sqlServer.GetEncryptionProtectors();

// invoke the operation
EncryptionProtectorName encryptionProtectorName = EncryptionProtectorName.Current;
EncryptionProtectorData data = new EncryptionProtectorData
{
    ServerKeyName = "someVault_someKey_01234567890123456789012345678901",
    ServerKeyType = SqlServerKeyType.AzureKeyVault,
    IsAutoRotationEnabled = false,
};
ArmOperation<EncryptionProtectorResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, encryptionProtectorName, data);
EncryptionProtectorResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
EncryptionProtectorData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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
dotnet

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/EncryptionProtectorCreateOrUpdateServiceManaged.json
// this example is just showing the usage of "EncryptionProtectors_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string serverName = "sqlcrudtest-4645";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this EncryptionProtectorResource
EncryptionProtectorCollection collection = sqlServer.GetEncryptionProtectors();

// invoke the operation
EncryptionProtectorName encryptionProtectorName = EncryptionProtectorName.Current;
EncryptionProtectorData data = new EncryptionProtectorData
{
    ServerKeyName = "ServiceManaged",
    ServerKeyType = SqlServerKeyType.ServiceManaged,
};
ArmOperation<EncryptionProtectorResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, encryptionProtectorName, data);
EncryptionProtectorResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
EncryptionProtectorData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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	Serverkrypteringsskyddet.
EncryptionProtectorName	Namnet på krypteringsskyddet som ska uppdateras.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ServerKeyType	Krypteringsskyddstypen som "ServiceManaged", "AzureKeyVault".

EncryptionProtector

Objekt

Serverkrypteringsskyddet.

Name	Typ	Description
id	string	Resurs-ID.
kind	string	Typ av krypteringsskydd. Det här är metadata som används för Azure-portalen.
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 krypteringsskyddet.
properties.thumbprint	string	Tumavtryck för servernyckeln.
properties.uri	string	URI:n för servernyckeln.
type	string	Resurstyp.

EncryptionProtectorName

Uppräkning

Namnet på krypteringsskyddet som ska uppdateras.

Värde	Description
current

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ServerKeyType

Uppräkning

Krypteringsskyddstypen som "ServiceManaged", "AzureKeyVault".

Värde	Description
ServiceManaged
AzureKeyVault

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

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerKeyType