Server Keys - Get

Szolgáltatás:

SQL Database

API-verzió:

2023-08-01

Lekéri a kiszolgálókulcsot.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
keyName	path	True	string	A lekérendő kiszolgálókulcs neve.
resourceGroupName	path	True	string	Az erőforrást tartalmazó erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
serverName	path	True	string	A kiszolgáló neve.
subscriptionId	path	True	string	Az Azure-előfizetést azonosító előfizetés-azonosító.
api-version	query	True	string	A kéréshez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	ServerKey	Sikeresen lekérte a megadott kiszolgálókulcsot.
Other Status Codes	ErrorResponse	Hibaválaszok: *** 400 ManagedInstanceStoppingOrStopped – Ütköző művelet van elküldve, miközben a példány leáll/leállított állapotban van 400 ManagedInstanceStarting – Ütköző művelet küldve, miközben a példány kezdő állapotban van 400 InvalidKeyName – Érvénytelen érték lett megadva a kiszolgálókulcs nevéhez. 400 InvalidKeyType – A kiszolgálókulcs létrehozása nem támogatott. 400 InvalidUpsertKeyType – A szolgáltatás által felügyelt TDE-kulcsokat a szolgáltatás kezeli. A szolgáltatás által felügyelt TDE-kulcsok nem támogatják a felhasználó általi létrehozást vagy frissítést. 400 InvalidKeyUpsertRequest – A kiszolgálókulcs létrehozása nem létezik, vagy nincs tulajdonságobjektuma. 404 ServerNotInSubscriptionResourceGroup – A megadott kiszolgáló nem létezik a megadott erőforráscsoportban és -előfizetésben. 404 SubscriptionDoesNotHaveServer – A kért kiszolgáló nem található 404 ResourceNotFound – A kért erőforrás nem található.

Példák

Get the server key

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ServerKey	Egy kiszolgálókulcs.
ServerKeyType	A kiszolgálókulcs típusa, például "ServiceManaged", "AzureKeyVault".

ErrorAdditionalInfo

Objektum

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

Objektum

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 hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ServerKey

Objektum

Egy kiszolgálókulcs.

Name	Típus	Description
id	string	Erőforrás-azonosító.
kind	string	Egyfajta titkosítási védő. Ez az Azure Portal felhasználói élményéhez használt metaadatok.
location	string	Erőforrás helye.
name	string	Erőforrás neve.
properties.autoRotationEnabled	boolean	A kulcs automatikus elforgatásának bejelentkezési jelzője. Igaz vagy hamis.
properties.creationDate	string (date-time)	A kiszolgálókulcs létrehozásának dátuma.
properties.serverKeyType	ServerKeyType	A kiszolgálókulcs típusa, például "ServiceManaged", "AzureKeyVault".
properties.subregion	string	A kiszolgálókulcs alrégiója.
properties.thumbprint	string	A kiszolgálókulcs ujjlenyomata.
properties.uri	string	A kiszolgálókulcs URI-ja. Ha a ServerKeyType az AzureKeyVault, akkor az URI szükséges. Az AKV URI-nak a következő formátumban kell lennie: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'
type	string	Erőforrás típusa.

ServerKeyType

Enumerálás

A kiszolgálókulcs típusa, például "ServiceManaged", "AzureKeyVault".

Érték	Description
ServiceManaged
AzureKeyVault