Server Keys - Create Or Update

Referenz

Dienst:: SQL Database

API-Version:: 2021-11-01

Erstellt oder aktualisiert einen Serverschlüssel.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
keyName	path	True	string	Der Name des zu betreibenden Serverschlüssels (aktualisiert oder erstellt). Der Schlüsselname muss sich im Format "vault_key_version" befinden. Wenn die keyId z. B. https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersionist, sollte der Serverschlüsselname wie folgt formatiert werden: YourVaultName_YourKeyName_YourKeyVersion
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
serverName	path	True	string	Der Name des Servers.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.serverKeyType	True	ServerKeyType	Der Serverschlüsseltyp wie "ServiceManaged", "AzureKeyVault".
properties.uri		string	Der URI des Serverschlüssels. Wenn der ServerKeyType AzureKeyVault ist, ist der URI erforderlich. Der AKV-URI muss in diesem Format vorliegen: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'

Antworten

Name	Typ	Beschreibung
200 OK	ServerKey	Der Serverschlüssel wurde erfolgreich aktualisiert.
201 Created	ServerKey	Der Serverschlüssel wurde erfolgreich erstellt.
202 Accepted		Angenommen
Other Status Codes		Fehlerantworten: *** 400 InvalidKeyName – Für den Serverschlüsselnamen wurde ein ungültiger Wert angegeben. 400 InvalidKeyType – Der Serverschlüsseltyp erstellen wird nicht unterstützt. 400 InvalidUpsertKeyType – Vom Dienst verwaltete TDE-Schlüssel werden vom Dienst verwaltet. Vom Dienst verwaltete TDE-Schlüssel unterstützen nicht das Erstellen oder Aktualisieren durch den Benutzer. 400 InvalidKeyUpsertRequest – Die Anforderung zum Erstellen von Serverschlüsseln ist nicht vorhanden oder weist kein Eigenschaftenobjekt auf. 400 SecurityAdalPrincipalCertExpiredError – Der Vorgang konnte nicht abgeschlossen werden, da das Azure Key Vault-Prinzipalzertifikat abgelaufen ist. 400 AkvHostNotResolvingFromNode - AKV-Host '{0}' ist nicht aus SQL, auf server '{1}'. 400 SecurityInvalidAzureKeyVaultRecoveryLevel – Der bereitgestellte Key Vault-URI ist ungültig. 400 KeyMaterialNotFoundOnRemoteServer – Remoteserver hat keinen Zugriff auf Schlüsselmaterial, das als TDE-Schutz verwendet wird. 400 AzureKeyVaultRsaKeyNotSupported – Der bereitgestellte Schlüsseltresor verwendet nicht unterstützte RSA Key Size oder Key Type. Die unterstützte RSA-Schlüsselgröße ist 2048 oder 3072, und der Schlüsseltyp ist RSA oder RSA-HSM. 400 AzureKeyVaultKeyDisabled – Der Vorgang konnte auf dem Server nicht abgeschlossen werden, da der Azure Key Vault-Schlüssel deaktiviert ist. 400 AzureKeyVaultInvalidExpirationDate – Der Vorgang konnte nicht abgeschlossen werden, da das Ablaufdatum des Azure Key Vault-Schlüssels ungültig ist. 400 SameKeyUriNotFoundOnRemoteServer – Der sekundäre Server verfügt nicht über das Schlüsselmaterial aus demselben Schlüsseltresor wie die Verschlüsselungsschutzvorrichtung des primären Servers mit aktivierter Automatischdrehung des Schlüssels. 400 SecurityAzureKeyVaultUrlNullOrEmpty – Der Vorgang konnte nicht abgeschlossen werden, da der Azure Key Vault-URI null oder leer ist. 400 SameKeyMaterialNotFoundOnRemoteServer – Sekundärer Server verfügt nicht über das Schlüsselmaterial der Verschlüsselungsschutzkomponente des primären Servers. 400 PerDatabaseCMKRestoreNotSupported – Datenbankwiederherstellung wird nicht unterstützt, wenn CMK auf Datenbankebene in der Vorschau konfiguriert ist. 400 AzureKeyVaultNoServerIdentity – Die Serveridentität ist nicht ordnungsgemäß konfiguriert. 400 PerDatabaseCMKHSNotSupported – CMK auf Datenbankebene in der Vorschau wird für Hyperscale Edition nicht unterstützt. 400 AzureKeyVaultInvalidUri – Eine ungültige Antwort von Azure Key Vault. Verwenden Sie einen gültigen Azure Key Vault-URI. 400 AzureKeyVaultMissingPermissions – Der Server fehlt die erforderlichen Berechtigungen für den Azure Key Vault. 400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId, die vom Benutzer bereitgestellt wird, hat keinen Zugriff auf KeyId bereitgestellt. 400 AkvEndpointNotReachableFromNode - AKV-Endpunkt '{0}' ist nicht erreichbar von SQL, auf server '{1}'. 400 SecurityAzureKeyVaultInvalidKeyName – Der Vorgang konnte aufgrund eines ungültigen Serverschlüsselnamens nicht abgeschlossen werden. 400 AdalGenericError – Der Vorgang konnte nicht abgeschlossen werden, weil ein Azure Active Directory-Fehler aufgetreten ist. 400 AdalServicePrincipalNotFound – Der Vorgang konnte nicht abgeschlossen werden, weil ein Azure Active Directory-Bibliotheksdienstprinzipal nicht gefunden wurde. 400 AzureKeyVaultMalformedVaultUri – Der bereitgestellte Key Vault-URI ist ungültig. 400 SecurityAzureKeyVaultGeoChainError – Das Erstellen einer sekundären (als Verkettung bezeichneter Prozess) wird beim Aktivieren der transparenten Datenverschlüsselung mit Azure Key Vault (BYOK) nicht unterstützt. 400 PerDatabaseCMKDWNotSupported – CMK auf Datenbankebene in der Vorschau wird für Datawarehouse Edition nicht unterstützt. 400 SecurityAdalPrincipalCertExpiredError – Der Vorgang konnte nicht abgeschlossen werden, da das Azure Key Vault-Prinzipalzertifikat abgelaufen ist. 400 AkvHostNotResolvingFromNode - AKV-Host '{0}' ist nicht aus SQL, auf server '{1}'. 400 SecurityInvalidAzureKeyVaultRecoveryLevel – Der bereitgestellte Key Vault-URI ist ungültig. 400 KeyMaterialNotFoundOnRemoteServer – Remoteserver hat keinen Zugriff auf Schlüsselmaterial, das als TDE-Schutz verwendet wird. 400 AzureKeyVaultRsaKeyNotSupported – Der bereitgestellte Schlüsseltresor verwendet nicht unterstützte RSA Key Size oder Key Type. Die unterstützte RSA-Schlüsselgröße ist 2048 oder 3072, und der Schlüsseltyp ist RSA oder RSA-HSM. 400 AzureKeyVaultKeyDisabled – Der Vorgang konnte auf dem Server nicht abgeschlossen werden, da der Azure Key Vault-Schlüssel deaktiviert ist. 400 AzureKeyVaultInvalidExpirationDate – Der Vorgang konnte nicht abgeschlossen werden, da das Ablaufdatum des Azure Key Vault-Schlüssels ungültig ist. 400 SameKeyUriNotFoundOnRemoteServer – Der sekundäre Server verfügt nicht über das Schlüsselmaterial aus demselben Schlüsseltresor wie die Verschlüsselungsschutzvorrichtung des primären Servers mit aktivierter Automatischdrehung des Schlüssels. 400 SecurityAzureKeyVaultUrlNullOrEmpty – Der Vorgang konnte nicht abgeschlossen werden, da der Azure Key Vault-URI null oder leer ist. 400 SameKeyMaterialNotFoundOnRemoteServer – Sekundärer Server verfügt nicht über das Schlüsselmaterial der Verschlüsselungsschutzkomponente des primären Servers. 400 PerDatabaseCMKRestoreNotSupported – Datenbankwiederherstellung wird nicht unterstützt, wenn CMK auf Datenbankebene in der Vorschau konfiguriert ist. 400 AzureKeyVaultNoServerIdentity – Die Serveridentität ist nicht ordnungsgemäß konfiguriert. 400 PerDatabaseCMKHSNotSupported – CMK auf Datenbankebene in der Vorschau wird für Hyperscale Edition nicht unterstützt. 400 AzureKeyVaultInvalidUri – Eine ungültige Antwort von Azure Key Vault. Verwenden Sie einen gültigen Azure Key Vault-URI. 400 AzureKeyVaultMissingPermissions – Der Server fehlt die erforderlichen Berechtigungen für den Azure Key Vault. 400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId, die vom Benutzer bereitgestellt wird, hat keinen Zugriff auf KeyId bereitgestellt. 400 AkvEndpointNotReachableFromNode - AKV-Endpunkt '{0}' ist nicht erreichbar von SQL, auf server '{1}'. 400 SecurityAzureKeyVaultInvalidKeyName – Der Vorgang konnte aufgrund eines ungültigen Serverschlüsselnamens nicht abgeschlossen werden. 400 AdalGenericError – Der Vorgang konnte nicht abgeschlossen werden, weil ein Azure Active Directory-Fehler aufgetreten ist. 400 AdalServicePrincipalNotFound – Der Vorgang konnte nicht abgeschlossen werden, weil ein Azure Active Directory-Bibliotheksdienstprinzipal nicht gefunden wurde. 400 AzureKeyVaultMalformedVaultUri – Der bereitgestellte Key Vault-URI ist ungültig. 400 SecurityAzureKeyVaultGeoChainError – Das Erstellen einer sekundären (als Verkettung bezeichneter Prozess) wird beim Aktivieren der transparenten Datenverschlüsselung mit Azure Key Vault (BYOK) nicht unterstützt. 400 PerDatabaseCMKDWNotSupported – CMK auf Datenbankebene in der Vorschau wird für Datawarehouse Edition nicht unterstützt. 404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden. 404 ServerNotInSubscriptionResourceGroup – Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden. 404 ResourceNotFound – Die angeforderte Ressource wurde nicht gefunden. 404 OperationIdNotFound – Der Vorgang mit der ID ist nicht vorhanden. 409 ServerKeyNameAlreadyExists – Der Serverschlüssel ist bereits auf dem Server vorhanden. 409 ServerKeyUriAlreadyExists – Der Serverschlüssel-URI ist bereits auf dem Server vorhanden. 409 ServerKeyDoesNotExists – Der Serverschlüssel ist nicht vorhanden. 409 AzureKeyVaultKeyNameNotFound – Der Vorgang konnte nicht abgeschlossen werden, da der Azure Key Vault Key-Name nicht vorhanden ist. 409 AzureKeyVaultKeyInUse – Der Schlüssel wird derzeit vom Server verwendet. 409 ServerKeyNameAlreadyExists – Der Serverschlüssel ist bereits auf dem Server vorhanden. 409 ServerKeyUriAlreadyExists – Der Serverschlüssel-URI ist bereits auf dem Server vorhanden. 409 ServerKeyDoesNotExists – Der Serverschlüssel ist nicht vorhanden. 409 AzureKeyVaultKeyNameNotFound – Der Vorgang konnte nicht abgeschlossen werden, da der Azure Key Vault Key-Name nicht vorhanden ist. 409 AzureKeyVaultKeyInUse – Der Schlüssel wird derzeit vom Server verwendet. 409 OperationCancelled – Der Vorgang wurde vom Benutzer abgebrochen. 409 OperationInterrupted – Der Vorgang für die Ressource konnte nicht abgeschlossen werden, weil er durch einen anderen Vorgang in derselben Ressource unterbrochen wurde. 429 SubscriptionTooManyCreateUpdateRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 429 SubscriptionTooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 500 OperationTimedOut – Timeout des Vorgangs und automatisches Zurücksetzen. Versuchen Sie den Vorgang erneut. 503 AzureKeyVaultConnectionFailed – Der Vorgang konnte auf dem Server nicht abgeschlossen werden, da Versuche, eine Verbindung mit Azure Key Vault herzustellen, fehlgeschlagen sind. 503 AzureKeyVaultGenericConnectionError – Der Vorgang konnte nicht abgeschlossen werden, weil beim Versuch, Key Vault-Informationen abzurufen, ein Fehler aufgetreten ist. 503 AzureKeyVaultConnectionFailed – Der Vorgang konnte auf dem Server nicht abgeschlossen werden, da Versuche, eine Verbindung mit Azure Key Vault herzustellen, fehlgeschlagen sind. 503 AzureKeyVaultGenericConnectionError – Der Vorgang konnte nicht abgeschlossen werden, weil beim Versuch, Key Vault-Informationen abzurufen, ein Fehler aufgetreten ist. 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

Beispiele

Creates or updates a server key

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


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

Beispiel für eine Antwort

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

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

Statuscode:: 202

Definitionen

Name	Beschreibung
ServerKey	Ein Serverschlüssel.
ServerKeyType	Der Serverschlüsseltyp wie "ServiceManaged", "AzureKeyVault".

ServerKey

Objekt

Ein Serverschlüssel.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Verschlüsselungsschutzkomponente. Dies sind Metadaten, die für die Azure-Portaloberfläche verwendet werden.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
properties.autoRotationEnabled	boolean	Kennzeichen für die automatische Drehung der Schlüsseldrehung. Entweder wahr oder falsch.
properties.creationDate	string (date-time)	Das Erstellungsdatum des Serverschlüssels.
properties.serverKeyType	ServerKeyType	Der Serverschlüsseltyp wie "ServiceManaged", "AzureKeyVault".
properties.subregion	string	Unterregion des Serverschlüssels.
properties.thumbprint	string	Fingerabdruck des Serverschlüssels.
properties.uri	string	Der URI des Serverschlüssels. Wenn der ServerKeyType AzureKeyVault ist, ist der URI erforderlich. Der AKV-URI muss in diesem Format vorliegen: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'
type	string	Ressourcentyp.

ServerKeyType

Enumeration

Der Serverschlüsseltyp wie "ServiceManaged", "AzureKeyVault".

Wert	Beschreibung
AzureKeyVault
ServiceManaged

Freigeben über