Encryption Protectors - Get

Dienst:

SQL Database

API-Version:

2023-08-01

Ruft einen Serververschlüsselungsschutz ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
encryptionProtectorName	path	True	EncryptionProtectorName	Der Name der abzurufenden Verschlüsselungsschutzkomponente.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
serverName	path	True	string	Der Name des Servers.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	EncryptionProtector	Die angegebene Serververschlüsselungsschutzkomponente wurde erfolgreich abgerufen.
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 ManagedInstanceStoppingOrStopped – Konfliktierender Vorgang, der während der Instanz beendet/beendet wird 400 ManagedInstanceStarting – Konfliktierender Vorgang, der während der Instanz im Startzustand liegt 400 InvalidKeyName – Für den Serverschlüsselnamen wurde ein ungültiger Wert angegeben. 400 InvalidKeyType – Der Serverschlüsseltyp erstellen wird nicht unterstützt. 400 InvalidUpsertKeyType – Vom Dienst verwaltete TDE-Schlüssel werden vom Dienst verwaltet. Vom Dienst verwaltete TDE-Schlüssel unterstützen nicht das Erstellen oder Aktualisieren durch den Benutzer. 400 InvalidKeyUpsertRequest – Die Anforderung zum Erstellen von Serverschlüsseln ist nicht vorhanden oder weist kein Eigenschaftenobjekt auf. 400 InvalidEncryptionProtectorName – Der Name des Verschlüsselungsschutzschlüssels wird nicht unterstützt. 404 ServerNotInSubscriptionResourceGroup – Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden. 404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden. 404 ResourceNotFound – Die angeforderte Ressource wurde nicht gefunden.

Beispiele

Get the encryption protector

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
EncryptionProtector	Der Serververschlüsselungsschutz.
EncryptionProtectorName	Der Name der abzurufenden Verschlüsselungsschutzkomponente.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ServerKeyType	Der Verschlüsselungsschutztyp wie "ServiceManaged", "AzureKeyVault".

EncryptionProtector

Objekt

Der Serververschlüsselungsschutz.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Verschlüsselungsschutzkomponente. Dies sind Metadaten, die für die Azure-Portaloberfläche verwendet werden.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
properties.autoRotationEnabled	boolean	Kennzeichen für die automatische Drehung der Schlüsseldrehung. Entweder wahr oder falsch.
properties.serverKeyName	string	Der Name des Serverschlüssels.
properties.serverKeyType	ServerKeyType	Der Verschlüsselungsschutztyp wie "ServiceManaged", "AzureKeyVault".
properties.subregion	string	Unterbereich der Verschlüsselungsschutzkomponente.
properties.thumbprint	string	Fingerabdruck des Serverschlüssels.
properties.uri	string	Der URI des Serverschlüssels.
type	string	Ressourcentyp.

EncryptionProtectorName

Enumeration

Der Name der abzurufenden Verschlüsselungsschutzkomponente.

Wert	Beschreibung
current

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ServerKeyType

Enumeration

Der Verschlüsselungsschutztyp wie "ServiceManaged", "AzureKeyVault".

Wert	Beschreibung
ServiceManaged
AzureKeyVault