Server Keys - Create Or Update

Tjänst:

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	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	Servernyckeltypen som "ServiceManaged", "AzureKeyVault".
properties.uri		string	URI:n för servernyckeln. Om ServerKeyType är AzureKeyVault krävs URI:n. AKV-URI:n måste vara i det här formatet: "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 – 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 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 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 – Det gick inte att slutföra åtgärden eftersom förfallodatumet för Azure Key Vault-nyckeln är ogiltigt. 400 SameKeyUriNotFoundOnRemoteServer – Sekundär server har inte nyckelmaterialet från samma nyckelvalv som den primära serverns krypteringsskydd med automatisk rotation aktiverad. 400 SecurityAzureKeyVaultUrlNullOrEmpty – Det gick inte att slutföra åtgärden eftersom Azure Key Vault-URI:n är null eller tom. 400 SameKeyMaterialNotFoundOnRemoteServer – sekundär server 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ö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 Azure Key Vault-URI. 400 AzureKeyVaultMissingPermissions – Servern saknar nödvändiga behörigheter i Azure Key Vault. 400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId som tillhandahålls av användaren har inte åtkomst till KeyId som tillhandahålls 400 AkvEndpointNotReachableFromNode – AKV-slutpunkten{0}kan inte nås från SQL, på serverns{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:n ä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å serverns{1}. 400 SecurityInvalidAzureKeyVaultRecoveryLevel – Den angivna Key Vault-URI:n ä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 – Det gick inte att slutföra åtgärden eftersom förfallodatumet för Azure Key Vault-nyckeln är ogiltigt. 400 SameKeyUriNotFoundOnRemoteServer – Sekundär server har inte nyckelmaterialet från samma nyckelvalv som den primära serverns krypteringsskydd med automatisk rotation aktiverad. 400 SecurityAzureKeyVaultUrlNullOrEmpty – Det gick inte att slutföra åtgärden eftersom Azure Key Vault-URI:n är null eller tom. 400 SameKeyMaterialNotFoundOnRemoteServer – sekundär server 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ö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 Azure Key Vault-URI. 400 AzureKeyVaultMissingPermissions – Servern saknar nödvändiga behörigheter i Azure Key Vault. 400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId som tillhandahålls av användaren har inte åtkomst till KeyId som tillhandahålls 400 AkvEndpointNotReachableFromNode – AKV-slutpunkten{0}kan inte nås från SQL, på serverns{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:n ä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 Azure Key Vault-nyckelnamnet 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 Azure Key Vault-nyckelnamnet 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 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 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

Creates or updates a server key

Exempelbegäran

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.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"),
            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/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
  }
}

Statuskod:

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

Statuskod:

202

Definitioner

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

ServerKey

Objekt

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-portalen.
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 (date-time)	Datum då servernyckeln skapades.
properties.serverKeyType	ServerKeyType	Servernyckeltypen som "ServiceManaged", "AzureKeyVault".
properties.subregion	string	Underregion för servernyckeln.
properties.thumbprint	string	Tumavtryck för servernyckeln.
properties.uri	string	URI:n för servernyckeln. Om ServerKeyType är AzureKeyVault krävs URI:n. AKV-URI:n måste vara i det här formatet: "https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion"
type	string	Resurstyp.

ServerKeyType

Uppräkning

Servernyckeltypen som "ServiceManaged", "AzureKeyVault".

Värde	Description
AzureKeyVault
ServiceManaged