Managed Instance Keys - Create Or Update

  • Riferimento
Service:
SQL Database
API Version:
2021-11-01

Crea o aggiorna una chiave di istanza gestita.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
keyName
 path True

string

Nome della chiave dell'istanza gestita da gestire (aggiornata o creata).
managedInstanceName
 path True

string

Nome dell'istanza gestita.
resourceGroupName
 path True

string

Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
subscriptionId
 path True

string

ID sottoscrizione che identifica una sottoscrizione di Azure.
api-version
 query True

string

Versione dell'API da usare per la richiesta.

Corpo della richiesta

Nome Necessario Tipo Descrizione
properties.serverKeyType True

ServerKeyType

Tipo di chiave come 'ServiceManaged', 'AzureKeyVault'.
properties.uri

string

URI della chiave. Se ServerKeyType è AzureKeyVault, è necessario l'URI.

Risposte

Nome Tipo Descrizione
200 OK

ManagedInstanceKey

È stato aggiornato correttamente la chiave dell'istanza gestita.
201 Created

ManagedInstanceKey

È stata creata correttamente la chiave dell'istanza gestita.
202 Accepted

Accettato
Other Status Codes

Risposte agli errori: **

  • 400 InvalidKeyName: viene assegnato un valore non valido per il nome della chiave del server.

  • 400 InvalidKeyType: il tipo di chiave del server di creazione non è supportato.

  • 400 InvalidUpsertKeyType : le chiavi TDE gestite dal servizio sono gestite dal servizio. Le chiavi TDE gestite dal servizio non supportano La creazione o l'aggiornamento dall'utente.

  • 400 InvalidKeyUpsertRequest: la richiesta di chiave del server di creazione non esiste o non ha alcun oggetto proprietà.

  • 400 SecurityAdalPrincipalCertExpiredError - Impossibile completare l'operazione perché il certificato dell'entità di azure Key Vault è scaduto.

  • 400 AkvHostNotResolvingFromNode - host AKV '{0}' non è risolvibile da SQL, nel server '{1}'.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel - L'URI fornito Key Vault non è valido.

  • 400 KeyMaterialNotFoundOnRemoteServer - Il server remoto non ha accesso al materiale chiave usato come protezione TDE.

  • 400 AzureKeyVaultRsaKeyNotSupported: l'insieme di credenziali delle chiavi fornito usa dimensioni chiave RSA o tipo di chiave non supportato. Le dimensioni della chiave RSA supportate sono 2048 o 3072 e il tipo di chiave è RSA o RSA-HSM.

  • 400 AzureKeyVaultKeyDisabled: impossibile completare l'operazione nel server perché la chiave di Key Vault di Azure è disabilitata.

  • 400 AzureKeyVaultInvalidExpirationDate - Impossibile completare l'operazione perché la data di scadenza della chiave di Azure Key Vault non è valida.

  • 400 SameKeyUriNotFoundOnRemoteServer - Il server secondario non dispone del materiale della chiave dello stesso insieme di credenziali delle chiavi della protezione della crittografia del server primario con rotazione automatica della chiave abilitata.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty - Impossibile completare l'operazione perché l'URI di Azure Key Vault è null o vuoto.

  • 400 SameKeyMaterialNotFoundOnRemoteServer - Il server secondario non ha il materiale chiave della protezione di crittografia del server primario.

  • 400 PerDatabaseCMKRestoreNotSupported - Il ripristino del database non è supportato quando il cmK a livello di database è configurato in anteprima.

  • 400 AzureKeyVaultNoServerIdentity : l'identità del server non è configurata correttamente.

  • 400 PerDatabaseCMKHSNotSupported - CmK a livello di database in anteprima non è supportato per Hyperscale Edition.

  • 400 AzureKeyVaultInvalidUri - Risposta non valida da Azure Key Vault. Usare un URI di Azure Key Vault valido.

  • 400 AzureKeyVaultMissingPermissions: il server manca delle autorizzazioni necessarie per l'Key Vault di Azure.

  • 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId fornito dall'utente non ha accesso a KeyId fornito

  • 400 AkvEndpointNotReachableFromNode - endpoint AKV '{0}' non è raggiungibile da SQL, nel server '{1}'.

  • 400 SecurityAzureKeyVaultInvalidKeyName- Impossibile completare l'operazione a causa di un nome chiave server non valido.

  • 400 AdalGenericError: impossibile completare l'operazione perché è stato rilevato un errore di Azure Active Directory.

  • 400 AdalServicePrincipalNotFound - Impossibile completare l'operazione perché è stato rilevato un errore dell'entità servizio libreria di Azure Active Directory.

  • 400 AzureKeyVaultMalformedVaultUri: l'uri Key Vault fornito non è valido.

  • 400 SecurityAzureKeyVaultGeoChainError - Creazione di un processo secondario (un processo noto come concatenamento) non è supportato quando si abilita Transparent Data Encryption usando Azure Key Vault (BYOK).

  • 400 PerDatabaseCMKDWNotSupported - CmK a livello di database in anteprima non è supportato per l'edizione Datawarehouse.

  • 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato

  • 404 ServerNotInSubscriptionResourceGroup - Il server specificato non esiste nel gruppo di risorse e nella sottoscrizione specificati.

  • 404 ResourceNotFound : la risorsa richiesta non è stata trovata.

  • 404 OperationIdNotFound: l'operazione con ID non esiste.

  • 409 ServerKeyNameAlreadyExists : la chiave del server esiste già nel server.

  • 409 ServerKeyUriAlreadyExists - L'URI della chiave del server esiste già nel server.

  • 409 ServerKeyDoesNotExists - La chiave server non esiste.

  • 409 AzureKeyVaultKeyKeyNameNotFound- Impossibile completare l'operazione perché il nome della chiave di Azure Key Vault non esiste.

  • 409 AzureKeyVaultKeyInUse: la chiave è attualmente usata dal server.

  • 409 OperationCancelled: l'operazione è stata annullata dall'utente.

  • 409 Operazione interrotta: impossibile completare l'operazione sulla risorsa perché è stata interrotta da un'altra operazione sulla stessa risorsa.

  • 429 SubscriptionTooManyCreateUpdateRequests - Richieste oltre le richieste massime che possono essere elaborate dalle risorse disponibili.

  • 429 SubscriptionTooManyRequests - Richieste oltre le richieste massime che possono essere elaborate dalle risorse disponibili.

  • 500 OperationTimedOut: l'operazione viene timeout e viene eseguito automaticamente il rollback. Ripetere l'operazione.

  • 503 AzureKeyVaultConnectionFailed - Impossibile completare l'operazione nel server perché i tentativi di connessione ad Azure Key Vault non sono riusciti

  • 503 AzureKeyVaultGenericConnectionError - Impossibile completare l'operazione perché si è verificato un errore durante il tentativo di recuperare informazioni Key Vault .

  • 503 TooManyRequests : richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili.

Esempio

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=2021-11-01

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

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

Definizioni

Nome Descrizione
ManagedInstanceKey

Chiave di istanza gestita.
ServerKeyType

Tipo di chiave come 'ServiceManaged', 'AzureKeyVault'.

ManagedInstanceKey

Chiave di istanza gestita.

Nome Tipo Descrizione
id

string

ID risorsa.
kind

string

Tipo di protezione di crittografia. Si tratta di metadati usati per l'esperienza di portale di Azure.
name

string

Nome risorsa.
properties.autoRotationEnabled

boolean

Contrassegno di consenso esplicito per la rotazione automatica delle chiavi. True o false.
properties.creationDate

string

Data di creazione della chiave.
properties.serverKeyType

ServerKeyType

Tipo di chiave come 'ServiceManaged', 'AzureKeyVault'.
properties.thumbprint

string

Identificazione personale della chiave.
properties.uri

string

URI della chiave. Se ServerKeyType è AzureKeyVault, è necessario l'URI.
type

string

Tipo di risorsa.

ServerKeyType

Tipo di chiave come 'ServiceManaged', 'AzureKeyVault'.

Nome Tipo Descrizione
AzureKeyVault

string

ServiceManaged

string