Delen via

Managed Instance Keys - Create Or Update

  • Referentie
Service:
SQL Database
API-versie:
2021-11-01

Hiermee maakt of werkt u een sleutel van een beheerd exemplaar bij.

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

URI-parameters

Name In Vereist Type Description
keyName
 path True

string

De naam van de sleutel van het beheerde exemplaar waarop moet worden gewerkt (bijgewerkt of gemaakt).
managedInstanceName
 path True

string

De naam van het beheerde exemplaar.
resourceGroupName
 path True

string

De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
subscriptionId
 path True

string

De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version
 query True

string

De API-versie die moet worden gebruikt voor de aanvraag.

Aanvraagbody

Name Vereist Type Description
properties.serverKeyType True

ServerKeyType

Het sleuteltype zoals 'ServiceManaged', 'AzureKeyVault'.
properties.uri

string

De URI van de sleutel. Als het ServerKeyType AzureKeyVault is, is de URI vereist.

Antwoorden

Name Type Description
200 OK

ManagedInstanceKey

De sleutel van het beheerde exemplaar is bijgewerkt.
201 Created

ManagedInstanceKey

De sleutel van het beheerde exemplaar is gemaakt.
202 Accepted

Geaccepteerd
Other Status Codes

Foutreacties: ***

  • 400 InvalidKeyName : er is een ongeldige waarde opgegeven voor de naam van de serversleutel.

  • 400 InvalidKeyType - Het type serversleutel maken wordt niet ondersteund.

  • 400 InvalidUpsertKeyType - Door de service beheerde TDE-sleutels worden beheerd door de service. Door de service beheerde TDE-sleutels bieden geen ondersteuning voor Maken of Bijwerken door de gebruiker.

  • 400 InvalidKeyUpsertRequest - De aanvraag voor de serversleutel maken bestaat niet of heeft geen eigenschappenobject.

  • 400 SecurityAdalPrincipalCertExpiredError: de bewerking kan niet worden voltooid omdat het Azure Key Vault principal-certificaat is verlopen.

  • 400 AkvHostNotResolvingFromNode - AKV-host '{0}' kan niet worden omgezet vanuit SQL, op server '{1}'.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel - De opgegeven Key Vault-URI is ongeldig.

  • 400 KeyMaterialNotFoundOnRemoteServer - Externe server heeft geen toegang tot sleutelmateriaal dat wordt gebruikt als een TDE-beveiliging.

  • 400 AzureKeyVaultRsaKeyNotSupported: de opgegeven sleutelkluis gebruikt niet-ondersteunde RSA-sleutelgrootte of sleuteltype. De ondersteunde RSA-sleutelgrootte is 2048 of 3072 en sleuteltype is RSA of RSA-HSM.

  • 400 AzureKeyVaultKeyDisabled: de bewerking kan niet worden voltooid op de server omdat de Azure Key Vault-sleutel is uitgeschakeld.

  • 400 AzureKeyVaultInvalidExpirationDate: de bewerking kan niet worden voltooid omdat de vervaldatum van de Azure Key Vault-sleutel ongeldig is.

  • 400 SameKeyUriNotFoundOnRemoteServer - Secundaire server heeft niet het sleutelmateriaal uit dezelfde sleutelkluis als de versleutelingsbeveiliging van de primaire server met automatische rotatie van sleutels ingeschakeld.

  • 400-beveiligingAzureKeyVaultUrlNullOrEmpty: de bewerking kan niet worden voltooid omdat de Azure Key Vault-URI null of leeg is.

  • 400 SameKeyMaterialNotFoundOnRemoteServer - Secundaire server beschikt niet over het sleutelmateriaal van de versleutelingsbeveiliging van de primaire server.

  • 400 PerDatabaseCMKRestoreNotSupported - Databaseherstel wordt niet ondersteund wanneer CMK op databaseniveau is geconfigureerd in preview.

  • 400 AzureKeyVaultNoServerIdentity: de serveridentiteit is niet juist geconfigureerd.

  • 400 PerDatabaseCMKHSNotSupported - CMK op databaseniveau in preview wordt niet ondersteund voor hyperscale-editie.

  • 400 AzureKeyVaultInvalidUri : een ongeldig antwoord van Azure Key Vault. Gebruik een geldige Azure Key Vault-URI.

  • 400 AzureKeyVaultMissingPermissions : de server mist vereiste machtigingen op de Azure Key Vault.

  • 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId die door de gebruiker is opgegeven, heeft geen toegang tot opgegeven KeyId

  • 400 AkvEndpointNotReachableFromNode - AKV-eindpunt '{0}' is niet bereikbaar vanuit SQL, op server '{1}'.

  • 400 SecurityAzureKeyVaultInvalidKeyName - De bewerking kan niet worden voltooid vanwege een ongeldige serversleutelnaam.

  • 400 AdalGenericError: de bewerking kan niet worden voltooid omdat er een Azure Active Directory-fout is opgetreden.

  • 400 AdalServicePrincipalNotFound : de bewerking kan niet worden voltooid omdat er een fout met de service-principal van de Azure Active Directory-bibliotheek niet gevonden is opgetreden.

  • 400 AzureKeyVaultMalformedVaultUri : de opgegeven Key Vault-URI is ongeldig.

  • 400-beveiligingAzureKeyVaultGeoChainError: het maken van een secundaire van secundaire (een proces dat ketenkoppeling wordt genoemd) wordt niet ondersteund bij het inschakelen van Transparent Data Encryption met behulp van Azure Key Vault (BYOK).

  • 400 PerDatabaseCMKDWNotSupported - CMK op databaseniveau in preview wordt niet ondersteund voor datawarehouse-editie.

  • 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden

  • 404 ServerNotInSubscriptionResourceGroup: de opgegeven server bestaat niet in de opgegeven resourcegroep en het opgegeven abonnement.

  • 404 ResourceNotFound - De aangevraagde resource is niet gevonden.

  • 404 OperationIdNotFound - De bewerking met id bestaat niet.

  • 409 ServerKeyNameAlreadyExists : de serversleutel bestaat al op de server.

  • 409 ServerKeyUriAlreadyExists : de serversleutel-URI bestaat al op de server.

  • 409 ServerKeyDoesNotExists - De serversleutel bestaat niet.

  • 409 AzureKeyVaultKeyNameNotFound : de bewerking kan niet worden voltooid omdat de naam van de Azure Key Vault-sleutel niet bestaat.

  • 409 AzureKeyVaultKeyInUse : de sleutel wordt momenteel gebruikt door de server.

  • 409 OperationCancelled : de bewerking is geannuleerd door de gebruiker.

  • 409 Bewerking onderbroken: de bewerking op de resource kan niet worden voltooid omdat deze is onderbroken door een andere bewerking op dezelfde resource.

  • 429 SubscriptionTooManyCreateUpdateRequests - Aanvragen die verder gaan dan het maximumaantal aanvragen dat kan worden verwerkt door beschikbare resources.

  • 429 SubscriptionTooManyRequests : aanvragen die verder gaan dan het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources.

  • 500 OperationTimedOut: er is een time-out opgetreden voor de bewerking en deze is automatisch teruggedraaid. Probeer de bewerking opnieuw uit te voeren.

  • 503 AzureKeyVaultConnectionFailed : de bewerking kan niet worden voltooid op de server omdat pogingen om verbinding te maken met Azure Key Vault zijn mislukt

  • 503 AzureKeyVaultGenericConnectionError: de bewerking kan niet worden voltooid omdat er een fout is opgetreden bij het ophalen van Key Vault informatie .

  • 503 TooManyRequests : aanvragen die verder gaan dan het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources.

Voorbeelden

Creates or updates a managed instance key

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
ManagedInstanceKey

Een sleutel van een beheerd exemplaar.
ServerKeyType

Het sleuteltype zoals 'ServiceManaged', 'AzureKeyVault'.

ManagedInstanceKey

Object

Een sleutel van een beheerd exemplaar.

Name Type Description
id

string

Resource-id.
kind

string

Soort versleutelingsbeveiliging. Dit zijn metagegevens die worden gebruikt voor de Azure Portal ervaring.
name

string

Resourcenaam.
properties.autoRotationEnabled

boolean

Opt-in vlag voor automatische rotatie van sleutels. Waar of onwaar.
properties.creationDate

string

De aanmaakdatum van de sleutel.
properties.serverKeyType

ServerKeyType

Het sleuteltype zoals 'ServiceManaged', 'AzureKeyVault'.
properties.thumbprint

string

Vingerafdruk van de sleutel.
properties.uri

string

De URI van de sleutel. Als het ServerKeyType AzureKeyVault is, is de URI vereist.
type

string

Resourcetype.

ServerKeyType

Enumeration

Het sleuteltype zoals 'ServiceManaged', 'AzureKeyVault'.

Waarde Description
AzureKeyVault
ServiceManaged