다음을 통해 공유

Server Keys - Create Or Update

서비스:
SQL Database
API 버전:
2025-01-01

서버 키를 만들거나 업데이트합니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
keyName
 path True

string

작동할 서버 키의 이름(업데이트 또는 생성)입니다. 키 이름은 'vault_key_version' 형식이어야 합니다. 예를 들어 keyId가 https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion경우 서버 키 이름은 다음과 같이 형식이 지정되어야 YourVaultName_YourKeyName_YourKeyVersion
resourceGroupName
 path True

string

리소스를 포함하는 리소스 그룹의 이름입니다. Azure Resource Manager API 또는 포털에서 이 값을 가져올 수 있습니다.
serverName
 path True

string

서버의 이름입니다.
subscriptionId
 path True

string

Azure 구독을 식별하는 구독 ID입니다.
api-version
 query True

string

요청에 사용할 API 버전입니다.

요청 본문

Name 필수 형식 Description
properties.serverKeyType True

ServerKeyType

'ServiceManaged', 'AzureKeyVault'와 같은 서버 키 형식입니다.
properties.uri

string

서버 키의 URI입니다. ServerKeyType이 AzureKeyVault인 경우 URI가 필요합니다. AKV URI는 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' 형식이거나 'https://YourVaultName.vault.azure.net/keys/YourKeyName'일 수 있습니다.

응답

Name 형식 Description
200 OK

ServerKey

서버 키를 업데이트했습니다.
201 Created

ServerKey

서버 키를 만들었습니다.
202 Accepted

수락됨

헤더

Location: string
Other Status Codes

ErrorResponse

오류 응답: ***

  • 400 ManagedInstanceStoppingOrStopped - 인스턴스가 중지/중지된 상태인 동안 제출된 충돌 작업

  • 400 ManagedInstanceStarting - 인스턴스가 시작 상태에 있는 동안 제출된 충돌 작업

  • 400 InvalidKeyName - 서버 키 이름에 잘못된 값이 지정되었습니다.

  • 400 InvalidKeyType - 서버 키 만들기 유형이 지원되지 않습니다.

  • 400 InvalidUpsertKeyType - 서비스 관리 TDE 키는 서비스에서 관리됩니다. 서비스 관리형 TDE 키는 사용자에 의한 만들기 또는 업데이트를 지원하지 않습니다.

  • 400 InvalidKeyUpsertRequest - 서버 키 만들기 요청이 없거나 속성 개체가 없습니다.

  • 400 SecurityAdalPrincipalCertExpiredError - Azure Key Vault 보안 주체 인증서가 만료되어 작업을 완료할 수 없습니다.

  • 400 AkvHostNotResolvingFromNode - AKV 호스트 '{0}'은 서버 '{1}'의 SQL에서 확인할 수 없습니다.

  • 400 AkvKeyDisabled - 고객 관리형 키에 대한 작업은 Azure Key Vault에서 허용되지 않습니다. 키에 대해 "get", "wrapKey", "unwrapKey" 작업을 허용하세요. 이 문제를 해결하는 데 도움이 되도록 다음을 참조 https://aka.ms/sqlmi-tde-troubleshooting하세요.

  • 400 AkvKeyOperationNotAllowed - 고객 관리형 키에 대한 작업은 Azure Key Vault에서 허용되지 않습니다. 키에 대해 "get", "wrapKey", "unwrapKey" 작업을 허용하세요. 이 문제를 해결하는 데 도움이 되도록 다음을 참조 https://aka.ms/sqlmi-tde-troubleshooting하세요.

  • 400 AkvKeyOperationNotAllowedByRBAC - Azure Key Vault에서 관리되는 인스턴스 ID의 현재 선택한 RBAC 역할에 대해 고객 관리형 키에 대한 필수 작업 중 하나가 허용되지 않습니다. 키 자격 증명 모음에 대한 다음 권한을 허용하는 RBAC 역할로 변경하세요. "get", "wrapKey", "unwrapKey". 이 문제를 해결하는 데 도움이 되도록 다음을 참조하세요. https://aka.ms/sqlmi-tde-troubleshooting

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel - 제공된 Key Vault URI가 잘못되었습니다.

  • 400 AkvKeyOperationNotAllowedByFirewall - Azure Key Vault 방화벽 정책에 의해 Azure Key Vault에 대한 연결이 금지되었습니다. Azure Key Vault 방화벽 정책을 검토하여 Managed Instance에서 연결을 사용하도록 설정하세요. 이 문제를 해결하는 데 도움이 되도록 다음을 참조 https://aka.ms/sqlmi-tde-troubleshooting하세요.

  • 400 AkvKeyAccessDenied - Azure Key Vault의 고객 관리형 키에 대한 필수 작업 중 하나는 관리 인스턴스 ID에서 사용하는 현재 설정된 키 자격 증명 모음 정책에 허용되지 않습니다. 키 자격 증명 모음에 대해 다음 권한을 허용하는 정책을 사용하세요. "get", "wrapKey", "unwrapKey". 이 문제를 해결하는 데 도움이 되도록 다음을 참조 https://aka.ms/sqlmi-tde-troubleshooting하세요.

  • 400 AkvKeyAccessGeneral403 - 권한 부족으로 인해 Managed Instance에서 요청한 Azure Key Vault 작업이 실패했습니다. 이 문제를 해결하는 데 도움이 되도록 다음을 참조 https://aka.ms/sqlmi-tde-troubleshooting하세요.

  • 400 MissingKeyVaultUriForRestore - 서버 '{0}'에서 데이터베이스 '{1}'을 성공적으로 복원하려면 Azure Key Vault 키 URI '{2}'이 필요합니다.

  • 400 AkvKeyDeleted - Azure Key Vault에서 고객 관리형 키를 찾을 수 없습니다. 최근에 삭제된 경우 키 자격 증명 모음에서 '일시 삭제' 보호를 사용하도록 설정하면 복구가 가능할 수 있습니다. 이 문제를 해결하는 데 도움이 되도록 다음을 참조 https://aka.ms/sqlmi-tde-troubleshooting하세요.

  • 400 AkvKeyTimeout - Azure Key Vault에 대한 연결을 설정할 수 없습니다. Managed Instance '%s'에 대한 네트워크 설정을 검토하세요. 이 문제를 해결하는 데 도움이 되도록 다음을 참조 https://aka.ms/sqlmi-tde-troubleshooting하세요.

  • 400 AzureKeyVaultKeyUsedOnGeoPrimary - Azure Key Vault 키 이름 {0} 현재 지역 기본에서 암호화 보호기로 설정되어 있으므로 작업을 완료할 수 없습니다.

  • 400 AkvKeyDNS - Azure Key Vault URI를 확인할 수 없습니다. 키 자격 증명 모음 URI가 유효하고 Managed Instance에 대한 네트워크 설정이 Azure 공용 DNS에 대한 액세스를 차단하지 않는지 확인하세요. 이 문제를 해결하는 데 도움이 되도록 다음을 참조 https://aka.ms/sqlmi-tde-troubleshooting하세요.

  • 400 KeyMaterialNotFoundOnRemoteServer - 원격 서버는 TDE 보호기로 사용되는 키 자료에 액세스할 수 없습니다.

  • 400 PerDatabaseCMKAKVKeyMaterialMissingOnGeoSecondary - 지역 복제의 모든 데이터베이스는 원본 데이터베이스의 암호화 보호자와 동일한 키 자료를 포함해야 합니다. 대상 데이터베이스 '{0}'에 동일한 키 자료가 있는 '{1}' 키를 추가하세요.

  • 400 AzureKeyVaultRsaKeyNotSupported - 제공된 키 자격 증명 모음은 지원되지 않는 RSA 키 크기 또는 키 형식을 사용합니다. 지원되는 RSA 키 크기는 2048 또는 3072이고 키 유형은 RSA 또는 RSA-HSM입니다.

  • 400 PerDatabaseCMKAKVKeyUriMissingOnGeoSecondary - 데이터베이스 수준 TDE 보호기의 자동 회전을 사용하도록 설정하면 원본 데이터베이스와 대상 데이터베이스가 모두 동일한 키 자격 증명 모음에 연결되어야 합니다. '{0}'(원본 데이터베이스에 연결된 동일한 키 자격 증명 모음에서)를 대상 데이터베이스 '{1}'에 추가하세요.

  • 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeysWithDatabaseName - 데이터베이스 수준 암호화 보호기로 구성된 데이터베이스를 복제하는 동안 주 데이터베이스에서 사용되는 현재 키를 보조 데이터베이스 '{0}'에 전달해야 합니다.

  • 400 ManagedInstanceNoConditionToMakeDatabaseAccessible - 해당 액세스 불가 근본 원인이 완화되지 않았기 때문에 SQL Managed Instance에서 하나 이상의 데이터베이스에 액세스할 수 없습니다. 현재 액세스할 수 없는 모든 데이터베이스의 액세스할 수 없는 근본 원인을 완화하고 작업을 다시 시도하세요.

  • 400 UmiMissingAkvPermissions - 사용자가 제공한 PrimaryUserAssignedIdentityId가 제공된 KeyId에 대한 액세스 권한이 없음

  • 400 SameKeyUriNotFoundOnRemoteServer - 보조 서버에는 키 자동 회전이 사용하도록 설정된 주 서버의 암호화 보호기와 동일한 키 자격 증명 모음의 키 자료가 없습니다.

  • 400 SameKeyMaterialNotFoundOnRemoteServer - 보조 서버에는 주 서버의 암호화 보호기의 키 자료가 없습니다.

  • 400 SecurityAzureKeyVaultGeoChainError - BYOK(Azure Key Vault)를 사용하여 투명한 데이터 암호화를 사용하도록 설정할 때 보조(체인이라고 하는 프로세스)의 보조 만들기는 지원되지 않습니다.

  • 400 PerDatabaseCMKDWNotSupported - 미리 보기의 데이터베이스 수준 CMK는 Datawarehouse 버전에서 지원되지 않습니다.

  • 400 BlockSystemAssignedIdentityForCrossTenantCMK - 서버가 사용자 할당 관리 ID로 구성된 경우에만 테넌트 간 CMK를 구성할 수 있습니다. 사용자 할당 관리 ID를 구성하려면 https://aka.ms/sqltdebyokumi 참조하세요.

  • 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys - 데이터베이스 수준 암호화 보호기로 구성된 데이터베이스를 복제하는 동안 주 데이터베이스에서 사용하는 현재 키를 보조 데이터베이스에 전달해야 합니다.

  • 400 CannotDropDatabaseAKVError - 서버 {0} 데이터베이스 {1} 삭제하기 전에 더 이상 액세스할 수 없는 고객 관리형 키로 암호화되므로 안전하게 삭제할 수 없습니다. 서버에서 Azure Key Vault 액세스를 복원하고 키의 유효성을 다시 검사하여 이 데이터베이스에 액세스할 수 있도록 한 다음 삭제를 계속 진행하세요. 자세한 내용은 https://aka.ms/tdecmkrestorability 참조하세요.

  • 400 CreateDatabaseAttemptedWithRotationInProgress - 서버에서 진행 중인 TDE(투명한 데이터 암호화) 키 회전으로 인해 현재 데이터베이스 만들기 작업을 수행할 수 없습니다. 나중에 작업을 다시 시도하세요.

  • 400 AzureKeyVaultKeyDisabled - Azure Key Vault 키를 사용할 수 없으므로 서버에서 작업을 완료할 수 없습니다.

  • 400 PerDatabaseCMKRestoreNotSupported - 데이터베이스 수준 CMK가 미리 보기로 구성된 경우 데이터베이스 복원이 지원되지 않습니다.

  • 400 AzureKeyVaultInvalidExpirationDate - Azure Key Vault 키 만료 날짜가 잘못되어 작업을 완료할 수 없습니다.

  • 400 PerDatabaseCMKHSNotSupported - 미리 보기의 데이터베이스 수준 CMK는 하이퍼스케일 버전에서 지원되지 않습니다.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty - Azure Key Vault Uri가 null이거나 비어 있으므로 작업을 완료할 수 없습니다.

  • 400 CMKOperationNotAllowed - 사용자가 서버에 Azure Key Vault 액세스 권한이 없을 때 서버에서 작업을 수행하려고 했습니다.

  • 400 AkvEndpointNotReachableFromNode - AKV 엔드포인트 '{0}'은 서버 '{1}'의 SQL에서 연결할 수 없습니다.

  • 400 AzureKeyVaultNoServerIdentity - 서버 ID가 올바르게 구성되지 않았습니다.

  • 400 AzureKeyVaultInvalidUri - Azure Key Vault의 잘못된 응답입니다. 유효한 Azure Key Vault URI를 사용하세요.

  • 400 AzureKeyVaultMissingPermissions - 서버에 Azure Key Vault에 대한 필수 권한이 없습니다.

  • 400 AzureKeyVaultKeyNameCurrentlyInUse - Azure Key Vault 키 이름 {0} 현재 사용 중이므로 작업을 완료할 수 없습니다.

  • 400 AzureKeyVaultKeyThumbprintIsDifferent - Azure Key Vault 키 자료가 현재 암호화 보호기 키와 다르기 때문에 작업을 완료할 수 없습니다.

  • 400 SecurityAzureKeyVaultInvalidKeyName - 잘못된 서버 키 이름으로 인해 작업을 완료할 수 없습니다.

  • 400 OldGenerationOfAKVKeyBeingUsedError - 이전 버전의 AKV 키를 TDE 보호기로 사용할 수 없습니다. 최신 버전의 AKV 키를 암호화 보호기로 사용하세요.

  • 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase - 데이터베이스당 CMK ID가 대상 데이터베이스에 설정되지 않았습니다.

  • 400 AdalGenericError - Azure Active Directory 오류가 발생하여 작업을 완료할 수 없습니다.

  • 400 AdalServicePrincipalNotFound - Azure Active Directory 라이브러리 서비스 주체를 찾을 수 없는 오류가 발생하여 작업을 완료할 수 없습니다.

  • 400 AzureKeyVaultMalformedVaultUri - 제공된 Key Vault URI가 잘못되었습니다.

  • 404 ServerNotInSubscriptionResourceGroup - 지정된 서버가 지정된 리소스 그룹 및 구독에 없습니다.

  • 404 SubscriptionDoesNotHaveServer - 요청된 서버를 찾을 수 없습니다.

  • 404 ResourceNotFound - 요청된 리소스를 찾을 수 없습니다.

  • 404 OperationIdNotFound - ID가 있는 작업이 없습니다.

  • 409 ServerKeyNameAlreadyExists - 서버 키가 서버에 이미 있습니다.

  • 409 ServerKeyUriAlreadyExists - 서버 키 URI가 서버에 이미 있습니다.

  • 409 ServerKeyDoesNotExists - 서버 키가 없습니다.

  • 409 AzureKeyVaultKeyNameNotFound - Azure Key Vault 키 이름이 없으므로 작업을 완료할 수 없습니다.

  • 409 AzureKeyVaultKeyInUse - 현재 서버에서 키를 사용하고 있습니다.

  • 409 CannotCancelOperation - 관리 작업이 취소할 수 없는 상태입니다.

  • 409 OperationCancelled - 사용자가 작업을 취소했습니다.

  • 409 OperationInterrupted - 동일한 리소스의 다른 작업에 의해 중단되었으므로 리소스에 대한 작업을 완료할 수 없습니다.

  • 429 SubscriptionTooManyCreateUpdateRequests - 사용 가능한 리소스에서 처리할 수 있는 최대 요청을 초과하는 요청입니다.

  • 429 SubscriptionTooManyRequests - 사용 가능한 리소스에서 처리할 수 있는 최대 요청을 초과하는 요청입니다.

  • 500 OperationTimedOut - 작업 시간이 초과되고 자동으로 롤백됩니다. 작업을 다시 시도하세요.

  • 503 AzureKeyVaultConnectionFailed - Azure Key Vault에 대한 연결 시도가 실패했기 때문에 서버에서 작업을 완료할 수 없습니다.

  • 503 AzureKeyVaultGenericConnectionError - Key Vault 정보를 검색하려고 할 때 오류가 발생하여 작업을 완료할 수 없습니다.

  • 503 TooManyRequests - 사용 가능한 리소스에서 처리할 수 있는 최대 요청을 초과하는 요청입니다.

예제

Creates or updates a server key
Creates or updates a server key with versionless key

Creates or updates a server key

샘플 요청

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=2025-01-01

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

샘플 응답

상태 코드:
200 
{
  "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": "2024-11-15T00:00:00Z"
  }
}
상태 코드:
201 
{
  "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": "2024-11-15T00:00:00Z"
  }
}
상태 코드:
202

Creates or updates a server key with versionless key

샘플 요청

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey?api-version=2025-01-01

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

샘플 응답

상태 코드:
200 
{
  "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": "2024-11-15T00:00:00Z"
  }
}
상태 코드:
201 
{
  "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": "2024-11-15T00:00:00Z"
  }
}
상태 코드:
202

정의

Name Description
ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.
ErrorDetail

오류 세부 정보입니다.
ErrorResponse

오류 응답
ServerKey

서버 키입니다.
ServerKeyType

'ServiceManaged', 'AzureKeyVault'와 같은 서버 키 형식입니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name 형식 Description
info

object

추가 정보입니다.
type

string

추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name 형식 Description
additionalInfo

ErrorAdditionalInfo[]

오류 추가 정보입니다.
code

string

오류 코드입니다.
details

ErrorDetail[]

오류 세부 정보입니다.
message

string

오류 메시지입니다.
target

string

오류 대상입니다.

ErrorResponse

Object

오류 응답

Name 형식 Description
error

ErrorDetail

오류 개체입니다.

ServerKey

Object

서버 키입니다.

Name 형식 Description
id

string

리소스 ID입니다.
kind

string

암호화 보호기의 종류입니다. Azure Portal 환경에 사용되는 메타데이터입니다.
location

string

리소스 위치입니다.
name

string

리소스 이름입니다.
properties.autoRotationEnabled

boolean

키 자동 회전 옵트인 플래그입니다. true 또는 false입니다.
properties.creationDate

string (date-time)

서버 키 생성 날짜입니다.
properties.keyVersion

string

서버 키의 버전입니다.
properties.serverKeyType

ServerKeyType

'ServiceManaged', 'AzureKeyVault'와 같은 서버 키 형식입니다.
properties.subregion

string

서버 키의 하위 리소스입니다.
properties.thumbprint

string

서버 키의 지문입니다.
properties.uri

string

서버 키의 URI입니다. ServerKeyType이 AzureKeyVault인 경우 URI가 필요합니다. AKV URI는 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' 형식이거나 'https://YourVaultName.vault.azure.net/keys/YourKeyName'일 수 있습니다.
type

string

리소스 종류입니다.

ServerKeyType

열거형

'ServiceManaged', 'AzureKeyVault'와 같은 서버 키 형식입니다.

값 Description
ServiceManaged
AzureKeyVault