Server Keys - Get

Layanan:

SQL Database

Versi API:

2023-08-01

Mendapatkan kunci server.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
keyName	path	True	string	Nama kunci server yang akan diambil.
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi sumber daya. Anda dapat memperoleh nilai ini dari API Azure Resource Manager atau portal.
serverName	path	True	string	Nama server.
subscriptionId	path	True	string	ID langganan yang mengidentifikasi langganan Azure.
api-version	query	True	string	Versi API yang akan digunakan untuk permintaan tersebut.

Respons

Nama	Jenis	Deskripsi
200 OK	ServerKey	Berhasil mengambil kunci server yang ditentukan.
Other Status Codes	ErrorResponse	Respons Kesalahan: *** 400 ManagedInstanceStoppingOrStopped - Operasi yang bertentangan dikirimkan saat instans dalam status berhenti/dihentikan 400 ManagedInstanceStarting - Operasi bertentangan yang dikirimkan saat instans dalam status mulai 400 InvalidKeyName - Nilai yang tidak valid diberikan untuk nama kunci server. 400 InvalidKeyType - Jenis kunci buat server tidak didukung. 400 InvalidUpsertKeyType - Kunci TDE yang dikelola layanan dikelola oleh layanan. Kunci TDE yang dikelola layanan tidak mendukung Buat atau Perbarui oleh pengguna. 400 InvalidKeyUpsertRequest - Permintaan buat kunci server tidak ada atau tidak memiliki objek properti. 404 ServerNotInSubscriptionResourceGroup - Server yang ditentukan tidak ada di grup sumber daya dan langganan yang ditentukan. 404 SubscriptionDoesNotHaveServer - Server yang diminta tidak ditemukan 404 ResourceNotFound - Sumber daya yang diminta tidak ditemukan.

Contoh

Get the server key

Permintaan sampel

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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
ServerKey	Kunci server.
ServerKeyType	Jenis kunci server seperti 'ServiceManaged', 'AzureKeyVault'.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ServerKey

Objek

Kunci server.

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.
kind	string	Jenis pelindung enkripsi. Ini adalah metadata yang digunakan untuk pengalaman portal Microsoft Azure.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.autoRotationEnabled	boolean	Bendera keikutsertaan rotasi otomatis kunci. Baik benar atau salah.
properties.creationDate	string (date-time)	Tanggal pembuatan kunci server.
properties.serverKeyType	ServerKeyType	Jenis kunci server seperti 'ServiceManaged', 'AzureKeyVault'.
properties.subregion	string	Subregion kunci server.
properties.thumbprint	string	Thumbprint kunci server.
properties.uri	string	URI kunci server. Jika ServerKeyType adalah AzureKeyVault, maka URI diperlukan. URI AKV harus dalam format ini: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'
type	string	Jenis sumber daya.

ServerKeyType

Enumeration

Jenis kunci server seperti 'ServiceManaged', 'AzureKeyVault'.

Nilai	Deskripsi
ServiceManaged
AzureKeyVault