Encryption Protectors - Get

Serviço:

SQL Database

Versão da API:

2023-08-01

Obtém um protetor de criptografia de servidor.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
encryptionProtectorName	path	True	EncryptionProtectorName	O nome do protetor de criptografia a ser recuperado.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.

Respostas

Name	Tipo	Description
200 OK	EncryptionProtector	Recuperado com êxito o protetor de criptografia do servidor especificado.
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 ManagedInstanceStoppingOrStopped - Operação conflitante enviada enquanto a instância está no estado de parada/parada 400 ManagedInstanceStarting - Operação conflitante enviada enquanto a instância está no estado inicial 400 InvalidKeyName - Um valor inválido foi fornecido para o nome da chave do servidor. 400 InvalidKeyType - O tipo de chave de servidor de criação não é suportado. 400 InvalidUpsertKeyType - As chaves TDE gerenciadas pelo serviço são gerenciadas pelo serviço. As chaves TDE gerenciadas pelo serviço não suportam Criar ou Atualizar pelo usuário. 400 InvalidKeyUpsertRequest - A solicitação de chave de servidor de criação não existe ou não tem nenhum objeto de propriedades. 400 InvalidEncryptionProtectorName - O nome da chave do protetor de criptografia não é suportado. 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na assinatura especificados. 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado 404 ResourceNotFound - O recurso solicitado não foi encontrado.

Exemplos

Get the encryption protector

Pedido de amostra

HTTP

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/EncryptionProtectorGet.json
// this example is just showing the usage of "EncryptionProtectors_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string serverName = "sqlcrudtest-4645";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this EncryptionProtectorResource
EncryptionProtectorCollection collection = sqlServer.GetEncryptionProtectors();

// invoke the operation
EncryptionProtectorName encryptionProtectorName = EncryptionProtectorName.Current;
NullableResponse<EncryptionProtectorResource> response = await collection.GetIfExistsAsync(encryptionProtectorName);
EncryptionProtectorResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    EncryptionProtectorData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/encryptionProtector",
  "location": "Japan East",
  "kind": "azurekeyvault",
  "properties": {
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901",
    "autoRotationEnabled": false
  }
}

Definições

Name	Description
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'.

EncryptionProtector

Object

O protetor de criptografia do servidor.

Name	Tipo	Description
id	string	ID do recurso.
kind	string	Tipo de protetor de criptografia. Esses são metadados usados para a experiência do portal do Azure.
location	string	Localização do recurso.
name	string	Nome do recurso.
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.
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.
type	string	Tipo de recurso.

EncryptionProtectorName

Enumeração

O nome do protetor de criptografia a ser recuperado.

Valor	Description
current

ErrorAdditionalInfo

Object

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

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
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 destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ServerKeyType

Enumeração

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

Valor	Description
ServiceManaged
AzureKeyVault