Server Keys - List By Server

Hizmet:

SQL Database

API Sürümü:

2025-01-01

Sunucu anahtarlarının listesini alır.

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

URI Parametreleri

Veri Akışı Adı	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. İsim büyük/küçük harfe duyarsızdır.
serverName	path	True	string	Sunucunun adı.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Veri Akışı Adı	Tür	Description
200 OK	ServerKeyListResult	Azure işlemi başarıyla tamamlandı.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Veri Akışı Adı	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

List the server keys by server

Örnek isteği

HTTP

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

Java

/**
 * Samples for ServerKeys ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ServerKeyList.json
     */
    /**
     * Sample code: List the server keys by server.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void listTheServerKeysByServer(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getServerKeys().listByServer("sqlcrudtest-7398", "sqlcrudtest-4645",
            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 server_key_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.server_keys.list_by_server(
        resource_group_name="sqlcrudtest-7398",
        server_name="sqlcrudtest-4645",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-01/ServerKeyList.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 server keys.
 *
 * @summary gets a list of server keys.
 * x-ms-original-file: 2025-01-01/ServerKeyList.json
 */
async function listTheServerKeysByServer() {
  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.serverKeys.listByServer("sqlcrudtest-7398", "sqlcrudtest-4645")) {
    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/ServerKeyList.json
// this example is just showing the usage of "ServerKeys_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 SqlServerKeyResource
SqlServerKeyCollection collection = sqlServer.GetSqlServerKeys();

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

Örnek yanıt

Durum kodu:

200

{
  "value": [
    {
      "name": "someVault_someKey_01234567890123456789012345678901",
      "type": "Microsoft.Sql/servers/keys",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
      "kind": "azurekeyvault",
      "location": "Japan East",
      "properties": {
        "serverKeyType": "AzureKeyVault",
        "creationDate": "2024-11-15T00:00:00Z",
        "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD"
      }
    },
    {
      "name": "myVault_myKey_11111111111111111111111111111111",
      "type": "Microsoft.Sql/servers/keys",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/myVault_myKey_11111111111111111111111111111111",
      "kind": "azurekeyvault",
      "location": "Japan East",
      "properties": {
        "serverKeyType": "AzureKeyVault",
        "creationDate": "2024-11-15T00:00:00Z",
        "thumbprint": "AAAAAAAAAAAAAAABBBBBBBBBBBBBBBBBBBBBBBBB"
      }
    },
    {
      "name": "ServiceManaged",
      "type": "Microsoft.Sql/servers/keys",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/ServiceManaged",
      "kind": "servicemanaged",
      "location": "Japan East",
      "properties": {
        "serverKeyType": "ServiceManaged"
      }
    }
  ]
}

Tanımlar

Veri Akışı Adı	Description
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
ServerKey	Sunucu anahtarı.
ServerKeyListResult	ServerKey listesi işleminin yanıtı.
ServerKeyType	'ServiceManaged', 'AzureKeyVault' gibi şifreleme koruyucusu türü.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

createdByType

Numaralandırma

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Veri Akışı Adı	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Veri Akışı Adı	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi

ErrorResponse

Nesne

Hata yanıtı

Veri Akışı Adı	Tür	Description
error	ErrorDetail	Hata nesnesi.

ServerKey

Nesne

Sunucu anahtarı.

Veri Akışı Adı	Tür	Description
id	string (arm-id)	Kaynağın tam kaynak kimliği. Örneğin "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Bir tür şifreleme koruyucusu. Bu, Azure portal deneyimi için kullanılan meta veridir.
location	string	Kaynak konumu.
name	string	Kaynağın adı
properties.autoRotationEnabled	boolean	Anahtar otomatik döndürme kabul etme bayrağı. True veya false.
properties.creationDate	string (date-time)	Sunucu anahtarı oluşturma tarihi.
properties.keyVersion	string	Sunucu anahtarının sürümü.
properties.serverKeyType	ServerKeyType	'ServiceManaged', 'AzureKeyVault' gibi sunucu anahtarı türü.
properties.subregion	string	Sunucu anahtarının alt kaydı.
properties.thumbprint	string	Sunucu anahtarının parmak izi.
properties.uri	string	Sunucu anahtarının URI'sini. ServerKeyType AzureKeyVault ise URI gereklidir. AKV URI'sinin şu biçimde olması gerekir: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' veya 'https://YourVaultName.vault.azure.net/keys/YourKeyName' olabilir
systemData	systemData	Azure Resource Manager metadata içeren createdBy ve modifiedBy bilgileri.
type	string	Kaynağın türü. Örneğin "Microsoft. Compute/virtualMachines" veya "Microsoft. Depo/Depolama Hesapları"

ServerKeyListResult

Nesne

ServerKey listesi işleminin yanıtı.

Veri Akışı Adı	Tür	Description
nextLink	string (uri)	Öğelerin bir sonraki sayfasına bağlantı
value	ServerKey[]	Bu sayfadaki ServerKey öğeleri

ServerKeyType

Numaralandırma

'ServiceManaged', 'AzureKeyVault' gibi şifreleme koruyucusu türü.

Değer	Description
ServiceManaged	ServiceManaged
AzureKeyVault	AzureKeyVault

systemData

Nesne

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Veri Akışı Adı	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.