Server Keys - Get

Service:

SQL Database

Version d'API:

2023-08-01

Obtient une clé de serveur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
keyName	path	True	string	Nom de la clé de serveur à récupérer.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Nom du serveur.
subscriptionId	path	True	string	ID d’abonnement qui identifie un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Réponses

Nom	Type	Description
200 OK	ServerKey	Récupérez correctement la clé de serveur spécifiée.
Other Status Codes	ErrorResponse	Réponses d’erreur : *** 400 ManagedInstanceStoppingOrStopped : opération en conflit envoyée pendant l’arrêt/l’état arrêté de l’instance 400 ManagedInstanceStarting - Opération en conflit envoyée pendant que l’instance est à l’état de démarrage 400 InvalidKeyName : une valeur non valide a été donnée pour le nom de clé du serveur. 400 InvalidKeyType : le type de clé de serveur de création n’est pas pris en charge. 400 InvalidUpsertKeyType - Les clés TDE gérées par le service sont gérées par le service. Les clés TDE gérées par le service ne prennent pas en charge La création ou la mise à jour par l’utilisateur. 400 InvalidKeyUpsertRequest : la demande de clé de serveur de création n’existe pas ou n’a pas d’objet de propriétés. 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés. 404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable 404 ResourceNotFound : la ressource demandée est introuvable.

Exemples

Get the server key

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ServerKey	Clé de serveur.
ServerKeyType	Type de clé de serveur comme « ServiceManaged », « AzureKeyVault ».

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ServerKey

Object

Clé de serveur.

Nom	Type	Description
id	string	ID de ressource.
kind	string	Type de protecteur de chiffrement. Il s’agit des métadonnées utilisées pour l’expérience du portail Azure.
location	string	Emplacement des ressources.
name	string	Nom de la ressource.
properties.autoRotationEnabled	boolean	Indicateur d’opt-in de rotation automatique de clé. True ou false.
properties.creationDate	string (date-time)	Date de création de la clé de serveur.
properties.serverKeyType	ServerKeyType	Type de clé de serveur comme « ServiceManaged », « AzureKeyVault ».
properties.subregion	string	Sous-région de la clé de serveur.
properties.thumbprint	string	Empreinte numérique de la clé de serveur.
properties.uri	string	URI de la clé de serveur. Si ServerKeyType est AzureKeyVault, l’URI est requis. L’URI AKV doit être au format suivant : 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'
type	string	Type de ressource.

ServerKeyType

Énumération

Type de clé de serveur comme « ServiceManaged », « AzureKeyVault ».

Valeur	Description
ServiceManaged
AzureKeyVault