Encryption Protectors - Create Or Update

Atualiza um protetor de criptografia existente.

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

Parâmetros do URI

Name Em Obrigatório Tipo Descrição
encryptionProtectorName
path True

EncryptionProtectorName

O nome do protetor de criptografia a ser recuperado.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serverName
path True

string

O nome do servidor.

subscriptionId
path True

string (uuid)

A ID da assinatura de destino. O valor deve ser um UUID.

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

Corpo do Pedido

Name Obrigatório Tipo Descrição
properties.serverKeyType True

ServerKeyType

O tipo de protetor de criptografia como 'ServiceManaged', 'AzureKeyVault'.

properties.autoRotationEnabled

boolean

Sinalizador de opção de rotação automática de chave. Verdadeiro ou falso.

properties.serverKeyName

string

O nome da chave do servidor.

Respostas

Name Tipo Descrição
200 OK

EncryptionProtector

Operação de atualização do recurso 'EncryptionProtector' bem-sucedida

202 Accepted

Operação de recurso aceita.

Cabeçalhos

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Descrição
user_impersonation personificar a sua conta de utilizador

Exemplos

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

Update the encryption protector to key vault

Pedido de amostra

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

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

Resposta da amostra

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

Update the encryption protector to key vault with versionless key

Pedido de amostra

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

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

Resposta da amostra

{
  "name": "current",
  "type": "Microsoft.Sql/servers/encryptionProtector",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current",
  "kind": "azurekeyvault",
  "location": "West US",
  "properties": {
    "autoRotationEnabled": false,
    "keyVersion": "01234567890123456789012345678901",
    "serverKeyName": "someVault_someKey",
    "serverKeyType": "AzureKeyVault"
  }
}

Update the encryption protector to service managed

Pedido de amostra

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

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

Resposta da amostra

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

Definições

Name Descrição
createdByType

O tipo de identidade que criou o recurso.

EncryptionProtector

O protetor de criptografia do servidor.

EncryptionProtectorName

O nome do protetor de criptografia a ser recuperado.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

ServerKeyType

O tipo de protetor de criptografia como 'ServiceManaged', 'AzureKeyVault'.

systemData

Metadados referentes à criação e última modificação do recurso.

createdByType

O tipo de identidade que criou o recurso.

Valor Descrição
User
Application
ManagedIdentity
Key

EncryptionProtector

O protetor de criptografia do servidor.

Name Tipo Descrição
id

string (arm-id)

ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

kind

string

Tipo de protetor de criptografia. Estes são metadados usados para a experiência do portal Azure.

location

string

Localização do recurso.

name

string

O nome do recurso

properties.autoRotationEnabled

boolean

Sinalizador de opção de rotação automática de chave. Verdadeiro ou falso.

properties.keyVersion

string

A versão da chave do servidor que está sendo usada como protetor de criptografia

properties.serverKeyName

string

O nome da chave do servidor.

properties.serverKeyType

ServerKeyType

O tipo de protetor de criptografia como 'ServiceManaged', 'AzureKeyVault'.

properties.subregion

string

Sub-região do protetor de criptografia.

properties.thumbprint

string

Impressão digital da chave do servidor.

properties.uri

string

O URI da chave do servidor.

systemData

systemData

Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.

type

string

O tipo do recurso. Por exemplo, "Microsoft. Computação/Máquinas Virtuais" ou "Microsoft. ContasArmazenamento/Armazenamento"

EncryptionProtectorName

O nome do protetor de criptografia a ser recuperado.

Valor Descrição
current

atual

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Descrição
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Descrição
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O alvo do erro.

ErrorResponse

Resposta de erro

Name Tipo Descrição
error

ErrorDetail

O objeto de erro.

ServerKeyType

O tipo de protetor de criptografia como 'ServiceManaged', 'AzureKeyVault'.

Valor Descrição
ServiceManaged

ServiceManaged

AzureKeyVault

AzureKeyVault

systemData

Metadados referentes à criação e última modificação do recurso.

Name Tipo Descrição
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.