Encryption Protectors - List By Server

Service:

SQL Database

API-versie:

2023-08-01

Hiermee haalt u een lijst met serverversleutelingsbeveiligingen op

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName	path	True	string	De naam van de server.
subscriptionId	path	True	string	De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag.

Antwoorden

Name	Type	Description
200 OK	EncryptionProtectorListResult	De lijst met serverversleutelingsbeveiliging is opgehaald.
Other Status Codes	ErrorResponse	Foutreacties: *** 400 ManagedInstanceStoppingOrStopped - Conflicterende bewerking verzonden terwijl het exemplaar de status gestopt/gestopt heeft 400 ManagedInstanceStarting - Conflicterende bewerking verzonden terwijl het exemplaar de beginstatus heeft 400 InvalidKeyName : er is een ongeldige waarde opgegeven voor de serversleutelnaam. 400 InvalidKeyType : het type serversleutel maken wordt niet ondersteund. 400 InvalidUpsertKeyType - Door de service beheerde TDE-sleutels worden beheerd door de service. Door de service beheerde TDE-sleutels bieden geen ondersteuning voor maken of bijwerken door de gebruiker. 400 InvalidKeyUpsertRequest: de aanvraag voor de serversleutel maken bestaat niet of heeft geen eigenschappenobject. 400 InvalidEncryptionProtectorName : de naam van de versleutelingsbeveiligingssleutel wordt niet ondersteund. 404 ServerNotInSubscriptionResourceGroup - Opgegeven server bestaat niet in de opgegeven resourcegroep en het opgegeven abonnement. 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden

Voorbeelden

List encryption protectors by server

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector?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/EncryptionProtectorList.json
// this example is just showing the usage of "EncryptionProtectors_ListByServer" 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 and iterate over the result
await foreach (EncryptionProtectorResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Voorbeeldrespons

Statuscode:

200

{
  "value": [
    {
      "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"
      }
    }
  ]
}

Definities

Name	Description
EncryptionProtector	De versleutelingsbeveiliging van de server.
EncryptionProtectorListResult	Een lijst met serverversleutelingsbeveiligingen.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
ServerKeyType	Het type versleutelingsbeveiliging, zoals 'ServiceManaged', 'AzureKeyVault'.

EncryptionProtector

Object

De versleutelingsbeveiliging van de server.

Name	Type	Description
id	string	Resource-id.
kind	string	Soort versleutelingsbeveiliging. Dit zijn metagegevens die worden gebruikt voor de Azure Portal-ervaring.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.autoRotationEnabled	boolean	Aanmeldingsvlag voor automatische rotatie van sleutels. Waar of onwaar.
properties.serverKeyName	string	De naam van de serversleutel.
properties.serverKeyType	ServerKeyType	Het type versleutelingsbeveiliging, zoals 'ServiceManaged', 'AzureKeyVault'.
properties.subregion	string	Subregio van de versleutelingsbeveiliging.
properties.thumbprint	string	Vingerafdruk van de serversleutel.
properties.uri	string	De URI van de serversleutel.
type	string	Resourcetype.

EncryptionProtectorListResult

Object

Een lijst met serverversleutelingsbeveiligingen.

Name	Type	Description
nextLink	string	Koppeling om de volgende pagina met resultaten op te halen.
value	EncryptionProtector[]	Matrix met resultaten.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ServerKeyType

Inventarisatie

Het type versleutelingsbeveiliging, zoals 'ServiceManaged', 'AzureKeyVault'.

Waarde	Description
ServiceManaged
AzureKeyVault