Sdílet prostřednictvím


Server Keys - Create Or Update

Vytvoří nebo aktualizuje klíč serveru.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
keyName
path True

string

Název klíče serveru, na který se má pracovat (aktualizováno nebo vytvořeno). Název klíče musí být ve formátu "vault_key_version". Pokud je například id klíče https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, měl by být název klíče serveru formátován takto: YourVaultName_YourKeyName_YourKeyVersion

resourceGroupName
path True

string

Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

serverName
path True

string

Název serveru.

subscriptionId
path True

string

ID předplatného, které identifikuje předplatné Azure.

api-version
query True

string

Verze rozhraní API, která se má použít pro požadavek.

Text požadavku

Name Vyžadováno Typ Description
properties.serverKeyType True

ServerKeyType

Typ klíče serveru, jako je ServiceManaged, AzureKeyVault.

properties.uri

string

Identifikátor URI klíče serveru. Pokud je ServerKeyType AzureKeyVault, je potřeba identifikátor URI. Identifikátor URI AKV musí být v tomto formátu: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'

Odpovědi

Name Typ Description
200 OK

ServerKey

Klíč serveru se úspěšně aktualizoval.

201 Created

ServerKey

Klíč serveru se úspěšně vytvořil.

202 Accepted

Přijal

Hlavičky

Location: string

Other Status Codes

ErrorResponse

Chybové odpovědi: ***

  • 400 ManagedInstanceStoppingOrStopped – Konfliktní operace odeslaná, když je instance v zastaveném nebo zastaveném stavu

  • 400 ManagedInstanceStarting – Konfliktní operace odeslaná při spuštění instance

  • 400 InvalidKeyName – pro název klíče serveru byla zadána neplatná hodnota.

  • 400 InvalidKeyType – Typ klíče pro vytvoření serveru není podporován.

  • 400 InvalidUpsertKeyType – Klíče transparentního šifrování dat spravované službou spravuje služba. Klíče transparentního šifrování dat spravované službou nepodporují vytvoření ani aktualizaci uživatelem.

  • 400 InvalidKeyUpsertRequest – Požadavek na vytvoření klíče serveru neexistuje nebo nemá žádný objekt vlastností.

  • 400 SecurityAdalPrincipalCertExpiredError – Operaci nebylo možné dokončit, protože vypršela platnost certifikátu objektu zabezpečení služby Azure Key Vault.

  • 400 AkvHostNotResolvingFromNode – hostitel AKV{0}není možné přeložit z SQL na serveru{1}.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel – zadaný identifikátor URI služby Key Vault není platný.

  • 400 MissingKeyVaultUriForRestore – Identifikátor URI klíče služby Azure Key Vault{0}se vyžaduje k úspěšnému obnovení databáze{1}pod serverem{2}.

  • 400 AzureKeyVaultKeyUsedOnGeoPrimary – operaci nebylo možné dokončit, protože název klíče služby Azure Key Vault {0} je aktuálně nastavený jako ochrana šifrování na geografické primárním serveru.

  • 400 KeyMaterialNotFoundOnRemoteServer – Vzdálený server nemá přístup k materiálu klíče používanému jako ochrana transparentním šifrováním dat.

  • 400 PerDatabaseCMKAKVKeyMaterialMissingOnGeoSecondary – Všechny databáze v geografické replikaci musí obsahovat stejný materiál klíče jako ochrana šifrování zdrojové databáze. Přidejte klíč{0}se stejným materiálem klíče do cílové databáze{1}.

  • 400 AzureKeyVaultRsaKeyNotSupported – Zadaný trezor klíčů používá nepodporovanou velikost klíče RSA nebo typ klíče. Podporovaná velikost klíče RSA je 2048 nebo 3072 a typ klíče je RSA nebo RSA-HSM.

  • 400 PerDatabaseCMKAKVKeyUriMissingOnGeoSecondary – Pokud je povolena automatická obměna ochrany transparentního šifrování dat na úrovni databáze, musí být zdrojové i cílové databáze připojené ke stejnému trezoru klíčů. Přidejte klíč{0}(ze stejného trezoru klíčů, který je připojený ke zdrojové databázi) do cílové databáze{1}.

  • 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeysWithDatabaseName – Při pokusu o replikaci databáze nakonfigurované s ochranou šifrování na úrovni databáze musí být aktuální klíče používané primární databází předány sekundární databázi '{0}' '

  • 400 ManagedInstanceNoConditionToMakeDatabaseAccessible – Operaci nelze dokončit, protože neexistuje dostatečná oprávnění ke spuštění pracovního postupu přístupnosti ve spravované instanci {0}.

  • 400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId poskytnutý uživatelem nemá přístup k zadanému ID klíče

  • 400 SameKeyUriNotFoundOnRemoteServer – Sekundární server nemá materiál klíče ze stejného trezoru klíčů jako ochrana šifrování primárního serveru s povolenou automatickou obměnou klíčem.

  • 400 SameKeyMaterialNotFoundOnRemoteServer – Sekundární server nemá klíč materiálu ochrany šifrování primárního serveru.

  • 400 SecurityAzureKeyVaultGeoChainError – Při povolení transparentního šifrování dat pomocí služby Azure Key Vault (BYOK) není podporováno vytváření sekundárních objektů (proces označovaný jako řetězení).

  • 400 PerDatabaseCMKDWNotSupported – CmK na úrovni databáze ve verzi Preview není podporován pro edici Datawarehouse.

  • 400 BlockSystemAssignedIdentityForCrossTenantCMK – CmK mezi tenanty lze nakonfigurovat pouze při konfiguraci serveru se spravovanou identitou přiřazenou uživatelem. Informace o konfiguraci spravované identity přiřazené uživatelem najdete v https://aka.ms/sqltdebyokumi.

  • 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys – Při pokusu o replikaci databáze nakonfigurované pomocí ochrany šifrování na úrovni databáze musí být aktuální klíče používané primární databází předány sekundární databázi.

  • 400 CannotDropDatabaseAKVError – databáze {0} na serveru {1} nelze bezpečně odstranit, protože je zašifrovaná pomocí klíče spravovaného zákazníkem, který už není přístupný pro provedení poslední zálohy před vyřazením. Obnovte na serveru přístup ke službě Azure Key Vault a obnovte klíče, aby byla tato databáze přístupná, a pokračujte v vyřazení. Podrobnosti najdete v tématu https://aka.ms/tdecmkrestorability

  • 400 CreateDatabaseAttemptedWithRotationInProgress – Operaci vytvoření databáze nelze v tuto chvíli provést kvůli probíhající obměně transparentního šifrování dat (TDE) na serveru. Zkuste operaci zopakovat později.

  • 400 AzureKeyVaultKeyDisabled – Operaci nebylo možné dokončit na serveru, protože klíč služby Azure Key Vault je zakázaný.

  • 400 PerDatabaseCMKRestoreNotSupported – Obnovení databáze není podporováno, pokud je klíč CMK na úrovni databáze nakonfigurovaný ve verzi Preview.

  • 400 AzureKeyVaultInvalidExpirationDate – Operaci nebylo možné dokončit, protože datum vypršení platnosti klíče služby Azure Key Vault je neplatné.

  • 400 PerDatabaseCMKHSNotSupported – CmK na úrovni databáze ve verzi Preview není podporován pro edici Hyperscale.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty – Operaci nelze dokončit, protože identifikátor URI služby Azure Key Vault má hodnotu null nebo je prázdný.

  • 400 CMKOperationNotAllowed – Uživatel se pokusil provést operaci na serveru, když server neměl přístup ke službě Azure Key Vault.

  • 400 AkvEndpointNotReachableFromNode – koncový bod AKV{0}není dostupný z SQL na serveru{1}.

  • 400 AzureKeyVaultNoServerIdentity – Identita serveru není správně nakonfigurovaná.

  • 400 AzureKeyVaultInvalidUri – neplatná odpověď ze služby Azure Key Vault. Použijte platný identifikátor URI služby Azure Key Vault.

  • 400 AzureKeyVaultMissingPermissions – Na serveru chybí požadovaná oprávnění ke službě Azure Key Vault.

  • 400 AzureKeyVaultKeyNameCurrentlyInUse – Operaci nebylo možné dokončit, protože název klíče služby Azure Key Vault {0} je aktuálně používán.

  • 400 AzureKeyVaultKeyThumbprintIsDifferent – Operaci nelze dokončit, protože materiál klíče služby Azure Key Vault se liší od aktuálního klíče ochrany šifrování.

  • 400 SecurityAzureKeyVaultInvalidKeyName – operaci nelze dokončit kvůli neplatnému názvu klíče serveru.

  • 400 OldGenerationOfAKVKeyBeingUsedError – Použití staré verze klíče AKV jako ochrany transparentním šifrováním dat není povolené. Jako ochranu šifrování použijte nejnovější verzi klíče AKV.

  • 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase – Identita CMK databáze není nastavena na cílovou databázi.

  • 400 AdalGenericError – Operaci nebylo možné dokončit, protože došlo k chybě Azure Active Directory.

  • 400 AdalServicePrincipalNotFound – Operaci nebylo možné dokončit, protože došlo k chybě instančního objektu knihovny Azure Active Directory.

  • 400 AzureKeyVaultMalformedVaultUri – zadaný identifikátor URI služby Key Vault není platný.

  • 400 SecurityAdalPrincipalCertExpiredError – Operaci nebylo možné dokončit, protože vypršela platnost certifikátu objektu zabezpečení služby Azure Key Vault.

  • 400 AkvHostNotResolvingFromNode – hostitel AKV{0}není možné přeložit z SQL na serveru{1}.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel – zadaný identifikátor URI služby Key Vault není platný.

  • 400 MissingKeyVaultUriForRestore – Identifikátor URI klíče služby Azure Key Vault{0}se vyžaduje k úspěšnému obnovení databáze{1}pod serverem{2}.

  • 400 AzureKeyVaultKeyUsedOnGeoPrimary – operaci nebylo možné dokončit, protože název klíče služby Azure Key Vault {0} je aktuálně nastavený jako ochrana šifrování na geografické primárním serveru.

  • 400 KeyMaterialNotFoundOnRemoteServer – Vzdálený server nemá přístup k materiálu klíče používanému jako ochrana transparentním šifrováním dat.

  • 400 PerDatabaseCMKAKVKeyMaterialMissingOnGeoSecondary – Všechny databáze v geografické replikaci musí obsahovat stejný materiál klíče jako ochrana šifrování zdrojové databáze. Přidejte klíč{0}se stejným materiálem klíče do cílové databáze{1}.

  • 400 AzureKeyVaultRsaKeyNotSupported – Zadaný trezor klíčů používá nepodporovanou velikost klíče RSA nebo typ klíče. Podporovaná velikost klíče RSA je 2048 nebo 3072 a typ klíče je RSA nebo RSA-HSM.

  • 400 PerDatabaseCMKAKVKeyUriMissingOnGeoSecondary – Pokud je povolena automatická obměna ochrany transparentního šifrování dat na úrovni databáze, musí být zdrojové i cílové databáze připojené ke stejnému trezoru klíčů. Přidejte klíč{0}(ze stejného trezoru klíčů, který je připojený ke zdrojové databázi) do cílové databáze{1}.

  • 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeysWithDatabaseName – Při pokusu o replikaci databáze nakonfigurované s ochranou šifrování na úrovni databáze musí být aktuální klíče používané primární databází předány sekundární databázi '{0}' '

  • 400 ManagedInstanceNoConditionToMakeDatabaseAccessible – Operaci nelze dokončit, protože neexistuje dostatečná oprávnění ke spuštění pracovního postupu přístupnosti ve spravované instanci {0}.

  • 400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId poskytnutý uživatelem nemá přístup k zadanému ID klíče

  • 400 SameKeyUriNotFoundOnRemoteServer – Sekundární server nemá materiál klíče ze stejného trezoru klíčů jako ochrana šifrování primárního serveru s povolenou automatickou obměnou klíčem.

  • 400 SameKeyMaterialNotFoundOnRemoteServer – Sekundární server nemá klíč materiálu ochrany šifrování primárního serveru.

  • 400 SecurityAzureKeyVaultGeoChainError – Při povolení transparentního šifrování dat pomocí služby Azure Key Vault (BYOK) není podporováno vytváření sekundárních objektů (proces označovaný jako řetězení).

  • 400 PerDatabaseCMKDWNotSupported – CmK na úrovni databáze ve verzi Preview není podporován pro edici Datawarehouse.

  • 400 BlockSystemAssignedIdentityForCrossTenantCMK – CmK mezi tenanty lze nakonfigurovat pouze při konfiguraci serveru se spravovanou identitou přiřazenou uživatelem. Informace o konfiguraci spravované identity přiřazené uživatelem najdete v https://aka.ms/sqltdebyokumi.

  • 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys – Při pokusu o replikaci databáze nakonfigurované pomocí ochrany šifrování na úrovni databáze musí být aktuální klíče používané primární databází předány sekundární databázi.

  • 400 CannotDropDatabaseAKVError – databáze {0} na serveru {1} nelze bezpečně odstranit, protože je zašifrovaná pomocí klíče spravovaného zákazníkem, který už není přístupný pro provedení poslední zálohy před vyřazením. Obnovte na serveru přístup ke službě Azure Key Vault a obnovte klíče, aby byla tato databáze přístupná, a pokračujte v vyřazení. Podrobnosti najdete v tématu https://aka.ms/tdecmkrestorability

  • 400 CreateDatabaseAttemptedWithRotationInProgress – Operaci vytvoření databáze nelze v tuto chvíli provést kvůli probíhající obměně transparentního šifrování dat (TDE) na serveru. Zkuste operaci zopakovat později.

  • 400 AzureKeyVaultKeyDisabled – Operaci nebylo možné dokončit na serveru, protože klíč služby Azure Key Vault je zakázaný.

  • 400 PerDatabaseCMKRestoreNotSupported – Obnovení databáze není podporováno, pokud je klíč CMK na úrovni databáze nakonfigurovaný ve verzi Preview.

  • 400 AzureKeyVaultInvalidExpirationDate – Operaci nebylo možné dokončit, protože datum vypršení platnosti klíče služby Azure Key Vault je neplatné.

  • 400 PerDatabaseCMKHSNotSupported – CmK na úrovni databáze ve verzi Preview není podporován pro edici Hyperscale.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty – Operaci nelze dokončit, protože identifikátor URI služby Azure Key Vault má hodnotu null nebo je prázdný.

  • 400 CMKOperationNotAllowed – Uživatel se pokusil provést operaci na serveru, když server neměl přístup ke službě Azure Key Vault.

  • 400 AkvEndpointNotReachableFromNode – koncový bod AKV{0}není dostupný z SQL na serveru{1}.

  • 400 AzureKeyVaultNoServerIdentity – Identita serveru není správně nakonfigurovaná.

  • 400 AzureKeyVaultInvalidUri – neplatná odpověď ze služby Azure Key Vault. Použijte platný identifikátor URI služby Azure Key Vault.

  • 400 AzureKeyVaultMissingPermissions – Na serveru chybí požadovaná oprávnění ke službě Azure Key Vault.

  • 400 AzureKeyVaultKeyNameCurrentlyInUse – Operaci nebylo možné dokončit, protože název klíče služby Azure Key Vault {0} je aktuálně používán.

  • 400 AzureKeyVaultKeyThumbprintIsDifferent – Operaci nelze dokončit, protože materiál klíče služby Azure Key Vault se liší od aktuálního klíče ochrany šifrování.

  • 400 SecurityAzureKeyVaultInvalidKeyName – operaci nelze dokončit kvůli neplatnému názvu klíče serveru.

  • 400 OldGenerationOfAKVKeyBeingUsedError – Použití staré verze klíče AKV jako ochrany transparentním šifrováním dat není povolené. Jako ochranu šifrování použijte nejnovější verzi klíče AKV.

  • 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase – Identita CMK databáze není nastavena na cílovou databázi.

  • 400 AdalGenericError – Operaci nebylo možné dokončit, protože došlo k chybě Azure Active Directory.

  • 400 AdalServicePrincipalNotFound – Operaci nebylo možné dokončit, protože došlo k chybě instančního objektu knihovny Azure Active Directory.

  • 400 AzureKeyVaultMalformedVaultUri – zadaný identifikátor URI služby Key Vault není platný.

  • 404 ServerNotInSubscriptionResourceGroup – Zadaný server neexistuje v zadané skupině prostředků a předplatném.

  • 404 SubscriptionDoesNotHaveServer – Požadovaný server nebyl nalezen.

  • 404 ResourceNotFound – Požadovaný prostředek nebyl nalezen.

  • 404 OperationIdNotFound – operace s ID neexistuje.

  • 409 ServerKeyNameAlreadyExists – klíč serveru již na serveru existuje.

  • 409 ServerKeyUriAlreadyExists – identifikátor URI klíče serveru již na serveru existuje.

  • 409 ServerKeyDoesNotExists – klíč serveru neexistuje.

  • 409 AzureKeyVaultKeyNameNotFound – Operaci nebylo možné dokončit, protože název klíče služby Azure Key Vault neexistuje.

  • 409 AzureKeyVaultKeyInUse – klíč aktuálně používá server.

  • 409 ServerKeyNameAlreadyExists – klíč serveru již na serveru existuje.

  • 409 ServerKeyUriAlreadyExists – identifikátor URI klíče serveru již na serveru existuje.

  • 409 ServerKeyDoesNotExists – klíč serveru neexistuje.

  • 409 AzureKeyVaultKeyNameNotFound – Operaci nebylo možné dokončit, protože název klíče služby Azure Key Vault neexistuje.

  • 409 AzureKeyVaultKeyInUse – klíč aktuálně používá server.

  • 409 CannotCancelOperation – Operace správy je ve stavu, který nelze zrušit.

  • 409 OperationCancelled - Operace byla zrušena uživatelem.

  • 409 OperationInterrupted – operaci s prostředkem nebylo možné dokončit, protože byla přerušena jinou operací na stejném prostředku.

  • 429 SubscriptionTooManyCreateUpdateRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.

  • 429 SubscriptionTooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.

  • 500 OperationTimedOut – Vypršel časový limit operace a automaticky se vrátil zpět. Zkuste operaci zopakovat.

  • 503 AzureKeyVaultConnectionFailed – Operaci se nepodařilo dokončit na serveru, protože pokusy o připojení ke službě Azure Key Vault selhaly.

  • 503 AzureKeyVaultGenericConnectionError – Operaci nelze dokončit, protože při pokusu o načtení informací služby Key Vault došlo k chybě.

  • 503 AzureKeyVaultConnectionFailed – Operaci se nepodařilo dokončit na serveru, protože pokusy o připojení ke službě Azure Key Vault selhaly.

  • 503 AzureKeyVaultGenericConnectionError – Operaci nelze dokončit, protože při pokusu o načtení informací služby Key Vault došlo k chybě.

  • 503 TooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.

Příklady

Creates or updates a server key

Ukázkový požadavek

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=2023-08-01

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

Ukázková odpověď

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

Definice

Name Description
ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Chybová odpověď

ServerKey

Klíč serveru.

ServerKeyType

Typ klíče serveru, jako je ServiceManaged, AzureKeyVault.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.

code

string

Kód chyby.

details

ErrorDetail[]

Podrobnosti o chybě.

message

string

Chybová zpráva.

target

string

Cíl chyby.

ErrorResponse

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.

ServerKey

Klíč serveru.

Name Typ Description
id

string

ID prostředku.

kind

string

Druh ochrany šifrování. Toto jsou metadata používaná pro prostředí webu Azure Portal.

location

string

Umístění prostředku

name

string

Název prostředku

properties.autoRotationEnabled

boolean

Příznak výslovného souhlasu s automatickým otáčením klíčů Buď pravda, nebo nepravda.

properties.creationDate

string (date-time)

Datum vytvoření klíče serveru.

properties.serverKeyType

ServerKeyType

Typ klíče serveru, jako je ServiceManaged, AzureKeyVault.

properties.subregion

string

Podregion klíče serveru.

properties.thumbprint

string

Kryptografický otisk klíče serveru.

properties.uri

string

Identifikátor URI klíče serveru. Pokud je ServerKeyType AzureKeyVault, je potřeba identifikátor URI. Identifikátor URI AKV musí být v tomto formátu: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'

type

string

Typ prostředku.

ServerKeyType

Typ klíče serveru, jako je ServiceManaged, AzureKeyVault.

Hodnota Description
ServiceManaged
AzureKeyVault