Managed Instance Keys - Create Or Update

Felügyelt példánykulcsot hoz létre vagy frissít.

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

URI-paraméterek

Name In Required Type Description
keyName
path True
  • string

Annak a felügyelt példánykulcsnak a neve, amelyen üzemeltetni (frissítve vagy létrehozva).

managedInstanceName
path True
  • string

A felügyelt példány neve.

resourceGroupName
path True
  • string

Az erőforrást tartalmazó erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.

subscriptionId
path True
  • string

Az Azure-előfizetést azonosító előfizetés-azonosító.

api-version
query True
  • string

A kéréshez használni kívánt API-verzió.

Kérelem törzse

Name Required Type Description
properties.serverKeyType True

A kulcs típusa, például "ServiceManaged", "AzureKeyVault".

properties.uri
  • string

A kulcs URI-ja. Ha a ServerKeyType az AzureKeyVault, akkor az URI szükséges.

Válaszok

Name Type Description
200 OK

A felügyelt példány kulcsának frissítése sikeresen megtörtént.

201 Created

Sikeresen létrehozta a felügyelt példánykulcsot.

202 Accepted

Elfogadva

Other Status Codes

Hibaválaszok: ***

  • 400 InvalidKeyName – Érvénytelen érték lett megadva a kiszolgálókulcs nevéhez.

  • 400 InvalidKeyType – A kiszolgálókulcs létrehozása nem támogatott.

  • 400 InvalidUpsertKeyType – A szolgáltatás által felügyelt TDE-kulcsokat a szolgáltatás kezeli. A szolgáltatás által felügyelt TDE-kulcsok nem támogatják a felhasználó általi létrehozást vagy frissítést.

  • 400 InvalidKeyUpsertRequest – A kiszolgálókulcs-létrehozási kérelem nem létezik, vagy nincs tulajdonságobjektuma.

  • 400 SecurityAdalPrincipalCertExpiredError – A művelet nem hajtható végre, mert az Azure Key Vault főtanúsítvány lejárt.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel – A megadott Key Vault URI érvénytelen.

  • 400 KeyMaterialNotFoundOnRemoteServer – A távoli kiszolgáló nem rendelkezik hozzáféréssel a TDE-védőként használt kulcsanyagokhoz.

  • 400 AzureKeyVaultRsaKeyNotSupported – A megadott kulcstartó nem támogatott RSA-kulcsméretet vagy kulcstípust használ. A támogatott RSA-kulcsméret 2048 vagy 3072, a kulcstípus pedig RSA vagy RSA-HSM.

  • 400 AzureKeyVaultKeyDisabled – A művelet nem hajtható végre a kiszolgálón, mert az Azure Key Vault kulcs le van tiltva.

  • 400 AzureKeyVaultInvalidExpirationDate – A művelet nem hajtható végre, mert az Azure Key Vault kulcs lejárati dátuma érvénytelen.

  • 400 SameKeyUriNotFoundOnRemoteServer – A másodlagos kiszolgáló nem rendelkezik a kulcsanyaggal ugyanabból a kulcstartóból, mint az elsődleges kiszolgáló titkosítási védője, és a kulcs automatikus rotálása engedélyezve van.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty – A művelet nem hajtható végre, mert az Azure Key Vault Uri null értékű vagy üres.

  • 400 SameKeyMaterialNotFoundOnRemoteServer – A másodlagos kiszolgáló nem rendelkezik az elsődleges kiszolgáló titkosítási védőjének kulcsanyagával.

  • 400 AzureKeyVaultNoServerIdentity – A kiszolgálóidentitás nincs megfelelően konfigurálva.

  • 400 AzureKeyVaultInvalidUri – Az Azure Key Vault érvénytelen válasza. Használjon érvényes Azure Key Vault URI-t.

  • 400 AzureKeyVaultMissingPermissions – A kiszolgáló nem rendelkezik szükséges engedélyekkel az Azure Key Vault.

  • 400 UmiMissingAkvPermissions – A felhasználó által megadott PrimaryUserAssignedIdentityId nem rendelkezik hozzáféréssel a megadott KeyId azonosítóhoz

  • 400 SecurityAzureKeyVaultInvalidKeyName – Érvénytelen kiszolgálókulcsnév miatt nem hajtható végre a művelet.

  • 400 AdalGenericError – A művelet nem hajtható végre, mert Azure Active Directory hiba történt.

  • 400 AdalServicePrincipalNotFound – A művelet nem hajtható végre, mert egy Azure Active Directory-erőforrástár szolgáltatásnév nem található hiba történt.

  • 400 AzureKeyVaultMalformedVaultUri – A megadott Key Vault URI érvénytelen.

  • 400 SecurityAzureKeyVaultGeoChainError – A másodlagos (láncolásnak nevezett) folyamat létrehozása nem támogatott, ha engedélyezi transzparens adattitkosítás az Azure Key Vault (BYOK) használatával.

  • 404 SubscriptionDoesNotHaveServer – A kért kiszolgáló nem található

  • 404 ServerNotInSubscriptionResourceGroup – A megadott kiszolgáló nem létezik a megadott erőforráscsoportban és előfizetésben.

  • 404 ResourceNotFound – A kért erőforrás nem található.

  • 409 ServerKeyNameAlreadyExists – A kiszolgálókulcs már létezik a kiszolgálón.

  • 409 ServerKeyUriAlreadyExists – A kiszolgálókulcs URI-ja már létezik a kiszolgálón.

  • 409 ServerKeyDoesNotExists – A kiszolgálókulcs nem létezik.

  • 409 AzureKeyVaultKeyNameNotFound – A művelet nem hajtható végre, mert az Azure Key Vault kulcsneve nem létezik.

  • 409 AzureKeyVaultKeyInUse – A kulcsot jelenleg a kiszolgáló használja.

  • 503 AzureKeyVaultConnectionFailed – A művelet nem hajtható végre a kiszolgálón, mert nem sikerült csatlakozni az Azure Key Vault

  • 503 AzureKeyVaultGenericConnectionError – A művelet nem hajtható végre, mert hiba történt Key Vault információ lekérésekor.

Példák

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

Definíciók

ManagedInstanceKey

Felügyelt példánykulcs.

ServerKeyType

A kulcs típusa, például "ServiceManaged", "AzureKeyVault".

ManagedInstanceKey

Felügyelt példánykulcs.

Name Type Description
id
  • string

Erőforrás-azonosító.

kind
  • string

A titkosítási védő típusa. Ez a Azure Portal élményhez használt metaadatok.

name
  • string

Erőforrás neve.

properties.autoRotationEnabled
  • boolean

Kulcs automatikus rotálásának jóváhagyási jelzője. Igaz vagy hamis.

properties.creationDate
  • string

A kulcs létrehozásának dátuma.

properties.serverKeyType

A kulcs típusa, például "ServiceManaged", "AzureKeyVault".

properties.thumbprint
  • string

A kulcs ujjlenyomata.

properties.uri
  • string

A kulcs URI-ja. Ha a ServerKeyType az AzureKeyVault, akkor az URI szükséges.

type
  • string

Erőforrástípus.

ServerKeyType

A kulcs típusa, például "ServiceManaged", "AzureKeyVault".

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string