Transparent Data Encryptions - List By Database

Szolgáltatás:

SQL Database

API-verzió:

2025-01-01

Lekéri a logikai adatbázis transzparens adattitkosításának listáját.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/transparentDataEncryption?api-version=2025-01-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
databaseName	path	True	string	Az adatbázis neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
serverName	path	True	string	A kiszolgáló neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	LogicalDatabaseTransparentDataEncryptionListResult	Az Azure működése sikeresen befejeződött.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Get a list of the database's transparent data encryption

Mintakérelem

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/security-tde-resourcegroup/providers/Microsoft.Sql/servers/securitytde/databases/testdb/transparentDataEncryption?api-version=2025-01-01

Java

/**
 * Samples for TransparentDataEncryptions ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/TransparentDataEncryptionList.json
     */
    /**
     * Sample code: Get a list of the database's transparent data encryption.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void
        getAListOfTheDatabaseSTransparentDataEncryption(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getTransparentDataEncryptions().listByDatabase("security-tde-resourcegroup",
            "securitytde", "testdb", com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python transparent_data_encryption_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.transparent_data_encryptions.list_by_database(
        resource_group_name="security-tde-resourcegroup",
        server_name="securitytde",
        database_name="testdb",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-01/TransparentDataEncryptionList.json
if __name__ == "__main__":
    main()

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

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets a list of the logical database's transparent data encryption.
 *
 * @summary gets a list of the logical database's transparent data encryption.
 * x-ms-original-file: 2025-01-01/TransparentDataEncryptionList.json
 */
async function getAListOfTheDatabaseTransparentDataEncryption() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.transparentDataEncryptions.listByDatabase(
    "security-tde-resourcegroup",
    "securitytde",
    "testdb",
  )) {
    resArray.push(item);
  }

  console.log(resArray);
}

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

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/SQL/stable/2025-01-01/examples/TransparentDataEncryptionList.json
// this example is just showing the usage of "TransparentDataEncryptions_ListByDatabase" 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 SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "security-tde-resourcegroup";
string serverName = "securitytde";
string databaseName = "testdb";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// get the collection of this LogicalDatabaseTransparentDataEncryptionResource
LogicalDatabaseTransparentDataEncryptionCollection collection = sqlDatabase.GetLogicalDatabaseTransparentDataEncryptions();

// invoke the operation and iterate over the result
await foreach (LogicalDatabaseTransparentDataEncryptionResource 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
    LogicalDatabaseTransparentDataEncryptionData 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

Mintaválasz

Állapotkód:

200

{
  "value": [
    {
      "name": "current",
      "type": "Microsoft.Sql/servers/databases/transparentDataEncryption",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/security-tde-resourcegroup/providers/Microsoft.Sql/servers/securitytde/databases/testdb",
      "properties": {
        "scanState": "Suspend",
        "state": "Enabled"
      }
    }
  ]
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
LogicalDatabaseTransparentDataEncryption	A logikai adatbázis transzparens adattitkosítási vizsgálati állapota.
LogicalDatabaseTransparentDataEncryptionListResult	A LogicalDatabaseTransparentDataEncryption lista művelet válasza.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
TransparentDataEncryptionScanState	Megadja a transzparens adattitkosítás titkosítási ellenőrzési állapotát.
TransparentDataEncryptionState	A transzparens adattitkosítás állapotát adja meg.

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célpontja.

ErrorResponse

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

LogicalDatabaseTransparentDataEncryption

Tárgy

A logikai adatbázis transzparens adattitkosítási vizsgálati állapota.

Name	Típus	Description
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Az erőforrás neve
properties.scanState	TransparentDataEncryptionScanState	Megadja a transzparens adattitkosítás titkosítási ellenőrzési állapotát.
properties.state	TransparentDataEncryptionState	A transzparens adattitkosítás állapotát adja meg.
systemData	systemData	Azure Resource Manager metaadat, amely createdBy és modifiedBy információkat tartalmaz.
type	string	Az erőforrás típusa. Például: "Microsoft. Compute/virtualMachines" vagy "Microsoft. Tárhely/tárolásFiókok"

LogicalDatabaseTransparentDataEncryptionListResult

Tárgy

A LogicalDatabaseTransparentDataEncryption lista művelet válasza.

Name	Típus	Description
nextLink	string (uri)	A következő oldalra mutató link
value	LogicalDatabaseTransparentDataEncryption[]	A LogicalDatabaseTransparentDataEncryption elemek ezen az oldalon

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

TransparentDataEncryptionScanState

Felsorolás

Megadja a transzparens adattitkosítás titkosítási ellenőrzési állapotát.

Érték	Description
None	Nincs
Resume	Folytatás
Running	Futás közben
Suspend	Felfüggeszt
Aborted	Megszakadt
Completed	Befejeződött

TransparentDataEncryptionState

Felsorolás

A transzparens adattitkosítás állapotát adja meg.

Érték	Description
Enabled	Engedélyezett
Disabled	Disabled