Server Keys - Get

Hizmet:

SQL Database

API Sürümü:

2023-08-01

Bir sunucu anahtarı alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
keyName	path	True	string	Alınacak sunucu anahtarının adı.
resourceGroupName	path	True	string	Kaynağı içeren kaynak grubunun adı. Bu değeri Azure Resource Manager API'sinden veya portaldan alabilirsiniz.
serverName	path	True	string	Sunucunun adı.
subscriptionId	path	True	string	Azure aboneliğini tanımlayan abonelik kimliği.
api-version	query	True	string	İstek için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	ServerKey	Belirtilen sunucu anahtarı başarıyla alındı.
Other Status Codes	ErrorResponse	Hata Yanıtları: *** 400 ManagedInstanceStoppingOrStopped - Örnek durdurulmuş/durdurulmuş durumdayken gönderilen çakışan işlem 400 ManagedInstanceStarting - Örnek başlatma durumundayken gönderilen çakışan işlem 400 InvalidKeyName - Sunucu anahtarı adı için geçersiz bir değer verildi. 400 InvalidKeyType - Sunucu anahtarı oluşturma türü desteklenmiyor. 400 InvalidUpsertKeyType - Hizmet tarafından yönetilen TDE anahtarları hizmet tarafından yönetilir. Hizmet tarafından yönetilen TDE anahtarları, kullanıcı tarafından Oluşturma veya Güncelleştirme'yi desteklemez. 400 InvalidKeyUpsertRequest - Sunucu anahtarı oluşturma isteği yok veya özellik nesnesi yok. 404 ServerNotInSubscriptionResourceGroup - Belirtilen sunucu belirtilen kaynak grubunda ve abonelikte yok. 404 SubscriptionDoesNotHaveServer - İstenen sunucu bulunamadı 404 ResourceNotFound - İstenen kaynak bulunamadı.

Örnekler

Get the server key

Ö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/someVault_someKey_01234567890123456789012345678901?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/ServerKeyGet.json
// this example is just showing the usage of "ServerKeys_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 SqlServerKeyResource
SqlServerKeyCollection collection = sqlServer.GetSqlServerKeys();

// invoke the operation
string keyName = "someVault_someKey_01234567890123456789012345678901";
NullableResponse<SqlServerKeyResource> response = await collection.GetIfExistsAsync(keyName);
SqlServerKeyResource 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
    SqlServerKeyData 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

Örnek yanıt

Durum kodu:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers/keys",
  "location": "Japan East",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2020-11-15T00:00:00Z",
    "autoRotationEnabled": false
  }
}

Tanımlar

Name	Description
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
ServerKey	Sunucu anahtarı.
ServerKeyType	'ServiceManaged', 'AzureKeyVault' gibi sunucu anahtarı türü.

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	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

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

ServerKey

Object

Sunucu anahtarı.

Name	Tür	Description
id	string	Kaynak Kimliği.
kind	string	Bir tür şifreleme koruyucusu. Bu, Azure portalı deneyimi için kullanılan meta verilerdir.
location	string	Kaynak konumu.
name	string	Kaynak 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.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'
type	string	Kaynak türü.

ServerKeyType

Listeleme

'ServiceManaged', 'AzureKeyVault' gibi sunucu anahtarı türü.

Değer	Description
ServiceManaged
AzureKeyVault