Managed Instance Keys - Create Or Update

Erstellt oder aktualisiert einen verwalteten Instanzschlüssel.

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

URI-Parameter

Name In Required Type Description
keyName
path True
  • string

Der Name des verwalteten Instanzschlüssels, der ausgeführt werden soll (aktualisiert oder erstellt).

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 Required Type Description
properties.serverKeyType True

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

properties.uri
  • string

Der URI des Schlüssels. Wenn der ServerKeyType AzureKeyVault ist, ist der URI erforderlich.

Antworten

Name Type Description
200 OK

Der verwaltete Instanzschlüssel wurde erfolgreich aktualisiert.

201 Created

Der verwaltete Instanzschlüssel wurde erfolgreich erstellt.

202 Accepted

Akzeptiert

Other Status Codes

Fehlerantworten: ***

  • 400 InvalidKeyName – Ein ungültiger Wert wurde für den Serverschlüsselnamen angegeben.

  • 400 InvalidKeyType – Der Serverschlüsseltyp wird nicht unterstützt.

  • 400 InvalidUpsertKeyType – Vom Dienst verwaltete TDE-Schlüssel werden vom Dienst verwaltet. Vom Benutzer 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 hat kein Eigenschaftenobjekt.

  • 400 SecurityAdalPrincipalCertExpiredError – Der Vorgang konnte nicht abgeschlossen werden, da das Azure Key Vault Prinzipalzertifikat abgelaufen ist.

  • 400 AkvHostNotResolvingFromNode - AKV-Host '{0}' ist nicht von SQL auf dem Server '{1}' aufgelöst.

  • 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-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 nicht auf dem Server abgeschlossen werden, da der Azure-Key Vault-Schlüssel deaktiviert ist.

  • 400 AzureKeyVaultInvalidExpirationDate – Der Vorgang konnte nicht abgeschlossen werden, da das Ablaufdatum von Azure Key Vault Schlüssel ungültig ist.

  • 400 SameKeyUriNotFoundOnRemoteServer – Sekundärer Server verfügt nicht über das Schlüsselmaterial aus demselben Schlüsseltresor wie die Verschlüsselungsschutzkomponente des primären Servers mit aktivierter automatischer Drehung 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 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 – Der Server fehlt an erforderlichen Berechtigungen für azure Key Vault.

  • 400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId, die vom Benutzer bereitgestellt wird, hat keinen Zugriff auf KeyId bereitgestellt.

  • 400 AkvEndpointNotReachableFromNode – AKV-Endpunkt '{0}' ist von SQL nicht erreichbar, auf dem 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, da ein Azure Active Directory-Bibliotheksdienstprinzipal nicht gefunden wurde.

  • 400 AzureKeyVaultMalformedVaultUri – Der bereitgestellte Key Vault URI ist ungültig.

  • 400 SecurityAzureKeyVaultGeoChainError – Das Erstellen sekundärer sekundärer Elemente (ein Prozess, der als Verketten bezeichnet wird) wird nicht unterstützt, wenn die transparente Datenverschlüsselung mithilfe von Azure Key Vault (BYOK) aktiviert wird.

  • 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.

  • 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.

  • 503 AzureKeyVaultConnectionFailed – Der Vorgang konnte nicht auf dem Server abgeschlossen werden, da Versuche, eine Verbindung mit Azure Key Vault herzustellen, fehlgeschlagen sind.

  • 503 AzureKeyVaultGenericConnectionError – Der Vorgang konnte nicht abgeschlossen werden, da beim Versuch, Key Vault Informationen abzurufen, ein Fehler aufgetreten ist.

Beispiele

Creates or updates a managed instance key

Sample Request

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=2022-02-01-preview

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

Sample Response

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

Definitionen

ManagedInstanceKey

Ein verwalteter Instanzschlüssel.

ServerKeyType

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

ManagedInstanceKey

Ein verwalteter Instanzschlüssel.

Name Type Description
id
  • string

Ressourcen-ID

kind
  • string

Art der Verschlüsselungsschutz. Dies ist Metadaten, die für die Azure-Portal Erfahrung verwendet werden.

name
  • string

Name der Ressource.

properties.autoRotationEnabled
  • boolean

Automatische Drehungskennzeichnung für Schlüssel. Entweder true oder false.

properties.creationDate
  • string

Das Datum der Schlüsselerstellung.

properties.serverKeyType

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

properties.thumbprint
  • string

Fingerabdruck des Schlüssels.

properties.uri
  • string

Der URI des Schlüssels. Wenn der ServerKeyType AzureKeyVault ist, ist der URI erforderlich.

type
  • string

Der Ressourcentyp.

ServerKeyType

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

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string