Lire en anglais

Partager via


Server Keys - List By Server

Obtient une liste de clés de serveur.

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

Paramètres URI

Nom Dans Obligatoire Type Description
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

Le nom du serveur

subscriptionId
path True

string

L’ID d’abonnement d’un abonnement Azure.

api-version
query True

string

Version de l’API à utiliser pour la requête.

Réponses

Nom Type Description
200 OK

ServerKeyListResult

La liste des clés de serveur a été récupérée.

Other Status Codes

Réponses d’erreur : ***

  • 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 create 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 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable

  • 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.

Exemples

List the server keys by server

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
ServerKey

Clé de serveur.

ServerKeyListResult

Liste des clés de serveur.

ServerKeyType

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

ServerKey

Clé de serveur.

Nom Type Description
id

string

ID de la ressource

kind

string

Type de protecteur de chiffrement. Il s’agit des métadonnées utilisées pour l’expérience Portail Azure.

location

string

Emplacement de la ressource.

name

string

Nom de la ressource.

properties.autoRotationEnabled

boolean

Indicateur d’option d’option de rotation automatique des touches. true ou false.

properties.creationDate

string

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é du serveur.

properties.thumbprint

string

Empreinte 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.

ServerKeyListResult

Liste des clés de serveur.

Nom Type Description
nextLink

string

Lien pour récupérer la page de résultats suivante.

value

ServerKey[]

Tableau de résultats.

ServerKeyType

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

Nom Type Description
AzureKeyVault

string

ServiceManaged

string