Managed Instance Encryption Protectors - Create Or Update

기존 암호화 보호기를 업데이트합니다.

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

URI 매개 변수

Name In Required Type Description
encryptionProtectorName
path True

업데이트할 암호화 보호기의 이름입니다.

managedInstanceName
path True
  • string

관리되는 인스턴스의 이름입니다.

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

Azure 구독을 식별하는 구독 ID입니다.

api-version
query True
  • string

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

요청 본문

Name Required Type Description
properties.serverKeyType True

'ServiceManaged', 'AzureKeyVault'와 같은 암호화 보호기 유형입니다.

properties.autoRotationEnabled
  • boolean

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

properties.serverKeyName
  • string

관리되는 인스턴스 키의 이름입니다.

응답

Name Type Description
200 OK

암호화 보호기를 업데이트했습니다.

202 Accepted

수락됨

Other Status Codes

오류 응답: ***

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

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

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

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

  • 400 InvalidEncryptionProtectorName - 암호화 보호기 키 이름은 지원되지 않습니다.

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

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

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

  • 400 AzureKeyVaultMismatchError - http 응답에 예기치 않은 Key Vault 지역이 있습니다.

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

  • 400 AzureKeyVaultKeyDisabled - Azure Key Vault 키가 비활성화되어 서버에서 작업을 완료할 수 없습니다.

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

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

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

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

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

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

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

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

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

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

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

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

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

  • 404 ServerKeyNotFound - 요청된 서버 키를 현재 구독에서 찾을 수 없습니다.

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

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

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

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

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

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

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

예제

Update the encryption protector to key vault
Update the encryption protector to service managed

Update the encryption protector to key vault

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current?api-version=2021-02-01-preview

{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
    "autoRotationEnabled": false
  }
}

Sample Response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/encryptionProtector",
  "kind": "azurekeyvault",
  "properties": {
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
    "serverKeyType": "AzureKeyVault",
    "autoRotationEnabled": false
  }
}

Update the encryption protector to service managed

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current?api-version=2021-02-01-preview

{
  "properties": {
    "serverKeyType": "ServiceManaged",
    "serverKeyName": "ServiceManaged"
  }
}

Sample Response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/encryptionProtector",
  "kind": "servicemanaged",
  "properties": {
    "serverKeyName": "ServiceManaged",
    "serverKeyType": "ServiceManaged"
  }
}

정의

EncryptionProtectorName

업데이트할 암호화 보호기의 이름입니다.

ManagedInstanceEncryptionProtector

관리되는 인스턴스 암호화 보호기입니다.

ServerKeyType

'ServiceManaged', 'AzureKeyVault'와 같은 암호화 보호기 유형입니다.

EncryptionProtectorName

업데이트할 암호화 보호기의 이름입니다.

Name Type Description
current
  • string

ManagedInstanceEncryptionProtector

관리되는 인스턴스 암호화 보호기입니다.

Name Type Description
id
  • string

리소스 ID입니다.

kind
  • string

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

name
  • string

리소스 이름입니다.

properties.autoRotationEnabled
  • boolean

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

properties.serverKeyName
  • string

관리되는 인스턴스 키의 이름입니다.

properties.serverKeyType

'ServiceManaged', 'AzureKeyVault'와 같은 암호화 보호기 유형입니다.

properties.thumbprint
  • string

서버 키의 지문입니다.

properties.uri
  • string

서버 키의 URI입니다.

type
  • string

리소스 종류.

ServerKeyType

'ServiceManaged', 'AzureKeyVault'와 같은 암호화 보호기 유형입니다.

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string