Managed Instance Keys - Create Or Update

Referenz

Service:: SQL Database

API Version:: 2021-11-01

Erstellt oder aktualisiert einen verwalteten instance-Schlüssel.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
keyName	path	True	string	Der Name des verwalteten instance Schlüssels, der ausgeführt (aktualisiert oder erstellt) werden soll.
managedInstanceName	path	True	string	Der Name der verwalteten Instanz.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.serverKeyType	True	ServerKeyType	Der Schlüsseltyp wie "ServiceManaged", "AzureKeyVault".
properties.uri		string	Der URI des Schlüssels. Wenn ServerKeyType AzureKeyVault ist, ist der URI erforderlich.

Antworten

Name	Typ	Beschreibung
200 OK	ManagedInstanceKey	Der verwaltete instance Schlüssel wurde erfolgreich aktualisiert.
201 Created	ManagedInstanceKey	Der verwaltete instance Schlüssel wurde erfolgreich erstellt.
202 Accepted		Akzeptiert
Other Status Codes		Fehlerantworten: *** 400 InvalidKeyName: Für den Serverschlüsselnamen wurde ein ungültiger Wert angegeben. 400 InvalidKeyType: Der Typ "Serverschlüssel 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 das Erstellen oder Aktualisieren durch den Benutzer nicht. 400 InvalidKeyUpsertRequest: Die Anforderung zum Erstellen des Serverschlüssels 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 : DER AKV-Host "{0}" kann nicht von SQL auf dem Server ""{1} aufgelöst werden. 400 SecurityInvalidAzureKeyVaultRecoveryLevel: Der angegebene Key Vault URI ist ungültig. 400 KeyMaterialNotFoundOnRemoteServer: Der Remoteserver hat keinen Zugriff auf Schlüsselmaterial, das als TDE-Schutz verwendet wird. 400 AzureKeyVaultRsaKeyNotSupported: Der bereitgestellte Schlüsseltresor verwendet nicht unterstützte RSA-Schlüsselgröße oder -Schlüsseltyp. 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 automatischer Schlüsselrotation. 400 SecurityAzureKeyVaultUrlNullOrEmpty: Der Vorgang konnte nicht abgeschlossen werden, da der Azure Key Vault-Uri NULL oder leer ist. 400 SameKeyMaterialNotFoundOnRemoteServer: Der sekundäre Server verfügt nicht über das Schlüsselmaterial der Verschlüsselungsschutzvorrichtung des primären Servers. 400 PerDatabaseCMKRestoreNotSupported: Die 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 die 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: Dem Server fehlen die erforderlichen Berechtigungen für den Azure-Key Vault. 400 UmiMissingAkvPermissions : PrimaryUserAssignedIdentityId, die vom Benutzer bereitgestellt wird, hat keinen Zugriff auf die bereitgestellte KeyId 400 AkvEndpointNotReachableFromNode : DER AKV-Endpunkt "{0}" ist von SQL auf dem Server "{1}" nicht erreichbar. 400 SecurityAzureKeyVaultInvalidKeyName: Der Vorgang konnte aufgrund eines ungültigen Serverschlüsselnamens nicht abgeschlossen werden. 400 AdalGenericError: Der Vorgang konnte nicht abgeschlossen werden, da ein Azure Active Directory-Fehler aufgetreten ist. 400 AdalServicePrincipalNotFound: Der Vorgang konnte nicht abgeschlossen werden, da ein Fehler beim Dienstprinzipal der Azure Active Directory-Bibliothek nicht gefunden wurde. 400 AzureKeyVaultMalformedVaultUri: Der angegebene Key Vault URI ist ungültig. 400 SecurityAzureKeyVaultGeoChainError: Das Erstellen eines sekundären sekundären (als Verkettung bezeichneten Prozesses) 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 die 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-Schlüsselname 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, da er durch einen anderen Vorgang für dieselbe Ressource unterbrochen wurde. 429 SubscriptionTooManyCreateUpdateRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können. 429 SubscriptionTooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können. 500 OperationTimedOut: Der Vorgang ist timeout und wird automatisch zurückgesetzt. Wiederholen Sie den Vorgang. 503 AzureKeyVaultConnectionFailed: Der Vorgang konnte auf dem Server nicht abgeschlossen werden, da die Verbindungsversuche mit Azure Key Vault fehlgeschlagen sind. 503 AzureKeyVaultGenericConnectionError: Der Vorgang konnte nicht abgeschlossen werden, da beim Versuch, Key Vault Informationen abzurufen, ein Fehler aufgetreten ist. 503 TooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.

Beispiele

Creates or updates a managed instance key

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/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.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ManagedInstanceKeyInner;
import com.azure.resourcemanager.sql.models.ServerKeyType;

/** Samples for ManagedInstanceKeys CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedInstanceKeyCreateOrUpdate.json
     */
    /**
     * Sample code: Creates or updates a managed instance key.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createsOrUpdatesAManagedInstanceKey(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstanceKeys().createOrUpdate("sqlcrudtest-7398",
            "sqlcrudtest-4645", "someVault_someKey_01234567890123456789012345678901",
            new ManagedInstanceKeyInner().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/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/managedInstances/keys",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2020-11-01T00:00:00Z",
    "autoRotationEnabled": false
  }
}

Status code:: 201

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

Status code:: 202

Definitionen

Name	Beschreibung
ManagedInstanceKey	Ein verwalteter instance-Schlüssel.
ServerKeyType	Der Schlüsseltyp wie "ServiceManaged", "AzureKeyVault".

ManagedInstanceKey

Ein verwalteter instance-Schlüssel.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
kind	string	Art von Verschlüsselungsschutz. Dies sind Metadaten, die für die Azure-Portal-Benutzeroberfläche verwendet werden.
name	string	Name der Ressource.
properties.autoRotationEnabled	boolean	Key Auto Rotation Opt-In Flag. Entweder true oder false.
properties.creationDate	string	Das Datum der Schlüsselerstellung.
properties.serverKeyType	ServerKeyType	Der Schlüsseltyp wie "ServiceManaged", "AzureKeyVault".
properties.thumbprint	string	Fingerabdruck des Schlüssels.
properties.uri	string	Der URI des Schlüssels. Wenn ServerKeyType AzureKeyVault ist, ist der URI erforderlich.
type	string	Der Ressourcentyp.

ServerKeyType

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

Name	Typ	Beschreibung
AzureKeyVault	string
ServiceManaged	string