Server Keys - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

Skapar eller uppdaterar en servernyckel.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
keyName	path	True	string	Namnet på den servernyckel som ska användas (uppdateras eller skapas). Nyckelnamnet måste vara i formatet "vault_key_version". Om keyId till exempel är https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersionska servernyckelnamnet formateras som: YourVaultName_YourKeyName_YourKeyVersion
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	Servernyckeltypen som "ServiceManaged", "AzureKeyVault".
properties.uri		string	URI för servernyckeln. Om ServerKeyType är AzureKeyVault krävs URI:n. AKV-URI:n måste ha följande format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'

Svar

Name	Typ	Description
200 OK	ServerKey	Servernyckeln har uppdaterats.
201 Created	ServerKey	Servernyckeln har skapats.
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 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å 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. Den RSA-nyckelstorlek 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 – Det gick inte att slutföra åtgärden eftersom förfallodatumet för Azure Key Vault-nyckeln ä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å har konfigurerats i förhandsversionen. 400 AzureKeyVaultNoServerIdentity – serveridentiteten är inte korrekt konfigurerad. 400 PerDatabaseCMKHSNotSupported – CMK på databasnivå i förhandsversionen stöds inte för Hyperskala-utgåvan. 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 – Det gick inte att slutföra åtgärden 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 det inte gick att hitta tjänstens huvudnamn för Azure Active Directory-biblioteket. 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. 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å 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. Den RSA-nyckelstorlek 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 – Det gick inte att slutföra åtgärden eftersom förfallodatumet för Azure Key Vault-nyckeln ä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å har konfigurerats i förhandsversionen. 400 AzureKeyVaultNoServerIdentity – serveridentiteten är inte korrekt konfigurerad. 400 PerDatabaseCMKHSNotSupported – CMK på databasnivå i förhandsversionen stöds inte för Hyperskala-utgåvan. 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 – Det gick inte att slutföra åtgärden 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 det inte gick att hitta tjänstens huvudnamn för Azure Active Directory-biblioteket. 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 OperationIdNotFound – åtgärden med ID finns inte. 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 Nyckelnamnet för Azure Key Vault inte finns. 409 AzureKeyVaultKeyInUse – nyckeln används för närvarande av servern. 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 Nyckelnamnet för Azure Key Vault inte finns. 409 AzureKeyVaultKeyInUse – nyckeln används för närvarande av servern. 409 OperationCancelled – Åtgärden har avbrutits av användaren. 409 OperationInterrupted – 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 – Åtgärden kunde inte slutföras 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 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

Creates or updates a server key

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901?api-version=2021-11-01

{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerKeyInner;
import com.azure.resourcemanager.sql.models.ServerKeyType;

/** Samples for ServerKeys CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerKeyCreateOrUpdate.json
     */
    /**
     * Sample code: Creates or updates a server key.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createsOrUpdatesAServerKey(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerKeys().createOrUpdate("sqlcrudtest-7398",
            "sqlcrudtest-4645", "someVault_someKey_01234567890123456789012345678901",
            new ServerKeyInner().withServerKeyType(ServerKeyType.AZURE_KEY_VAULT).withUri(
                "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"),
            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

Sample Response

Status code:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers/keys",
  "location": "Japan East",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2020-11-15T00:00:00Z",
    "autoRotationEnabled": false
  }
}

Status code:

201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers/keys",
  "location": "Japan East",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2020-11-15T00:00:00Z",
    "autoRotationEnabled": false
  }
}

Status code:

202

Definitioner

Name	Description
ServerKey	En servernyckel.
ServerKeyType	Servernyckeltypen som "ServiceManaged", "AzureKeyVault".

ServerKey

En servernyckel.

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.creationDate	string	Datum då servernyckeln skapades.
properties.serverKeyType	ServerKeyType	Servernyckeltypen som "ServiceManaged", "AzureKeyVault".
properties.subregion	string	Servernyckelns underregion.
properties.thumbprint	string	Tumavtryck för servernyckeln.
properties.uri	string	URI för servernyckeln. Om ServerKeyType är AzureKeyVault krävs URI:n. AKV-URI:n måste ha följande format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'
type	string	Resurstyp.

ServerKeyType

Servernyckeltypen som "ServiceManaged", "AzureKeyVault".

Name	Typ	Description
AzureKeyVault	string
ServiceManaged	string