Server Keys - Create Or Update

Référence

Service:: SQL Database

Version d'API:: 2021-11-01

Crée ou met à jour une clé de serveur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
keyName	path	True	string	Nom de la clé de serveur à utiliser (mise à jour ou création). Le nom de clé doit être au format « vault_key_version ». Par exemple, si le keyId est https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, le nom de la clé de serveur doit être mis en forme comme suit : YourVaultName_YourKeyName_YourKeyVersion
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.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.serverKeyType	True	ServerKeyType	Type de clé de serveur comme « ServiceManaged », « AzureKeyVault ».
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'

Réponses

Nom	Type	Description
200 OK	ServerKey	Mise à jour réussie de la clé de serveur.
201 Created	ServerKey	La clé du serveur a été créée.
202 Accepted		Accepté
Other Status Codes		Réponses d’erreur : *** 400 InvalidKeyName : une valeur non valide a été donnée pour le nom de la clé de 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 création de clé de serveur n’existe pas ou n’a pas d’objet de propriétés. 400 SecurityAdalPrincipalCertExpiredError : l’opération n’a pas pu être effectuée, car le certificat principal Azure Key Vault a expiré. 400 AkvHostNotResolvingFromNode : l’hôte AKV «{0} » n’est pas résolvable à partir de SQL, sur le serveur « ».{1} 400 SecurityInvalidAzureKeyVaultRecoveryLevel : l’URI Key Vault fourni n’est pas valide. 400 KeyMaterialNotFoundOnRemoteServer : le serveur distant n’a pas accès au matériel de clé utilisé comme protecteur TDE. 400 AzureKeyVaultRsaKeyNotSupported : le coffre de clés fourni utilise une taille de clé RSA ou un type de clé non pris en charge. La taille de clé RSA prise en charge est 2048 ou 3072 et le type de clé est RSA ou RSA-HSM. 400 AzureKeyVaultKeyDisabled : l’opération n’a pas pu être effectuée sur le serveur, car la clé Azure Key Vault est désactivée. 400 AzureKeyVaultInvalidExpirationDate : l’opération n’a pas pu être terminée, car la date d’expiration de la clé Azure Key Vault n’est pas valide. 400 SameKeyUriNotFoundOnRemoteServer : le serveur secondaire n’a pas le matériel de clé du même coffre de clés que le protecteur de chiffrement du serveur principal avec la rotation automatique des clés activée. 400 SecurityAzureKeyVaultUrlNullOrEmpty : l’opération n’a pas pu être effectuée, car l’URI azure Key Vault est null ou vide. 400 SameKeyMaterialNotFoundOnRemoteServer : le serveur secondaire n’a pas le matériel de clé du protecteur de chiffrement du serveur principal. 400 PerDatabaseCMKRestoreNotSupported : la restauration de base de données n’est pas prise en charge lorsque la clé CMK au niveau de la base de données est configurée en préversion. 400 AzureKeyVaultNoServerIdentity : l’identité du serveur n’est pas correctement configurée. 400 PerDatabaseCMKHSNotSupported : cmk au niveau de la base de données en préversion n’est pas pris en charge pour l’édition Hyperscale. 400 AzureKeyVaultInvalidUri : réponse non valide d’Azure Key Vault. Utilisez un URI de Key Vault Azure valide. 400 AzureKeyVaultMissingPermissions : le serveur n’a pas les autorisations requises sur le Key Vault Azure. 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId fourni par l’utilisateur n’a pas accès à KeyId fourni 400 AkvEndpointNotReachableFromNode : le point de terminaison AKV «{0} » n’est pas accessible à partir de SQL, sur le serveur « ».{1} 400 SecurityAzureKeyVaultInvalidKeyName : l’opération n’a pas pu être effectuée en raison d’un nom de clé de serveur non valide. 400 AdalGenericError : l’opération n’a pas pu être terminée, car une erreur Azure Active Directory a été rencontrée. 400 AdalServicePrincipalNotFound : l’opération n’a pas pu être terminée, car une erreur de principal de service introuvable dans la bibliothèque Azure Active Directory a été rencontrée. 400 AzureKeyVaultMalformedVaultUri : l’URI de Key Vault fourni n’est pas valide. 400 SecurityAzureKeyVaultGeoChainError : la création d’un composant secondaire (un processus appelé chaînage) n’est pas prise en charge lors de l’activation de Transparent Data Encryption à l’aide d’Azure Key Vault (BYOK). 400 PerDatabaseCMKDWNotSupported : la clé CMK au niveau de la base de données en préversion n’est pas prise en charge pour l’édition Datawarehouse. 400 SecurityAdalPrincipalCertExpiredError : l’opération n’a pas pu être effectuée, car le certificat principal Azure Key Vault a expiré. 400 AkvHostNotResolvingFromNode : l’hôte AKV «{0} » n’est pas résolvable à partir de SQL, sur le serveur « ».{1} 400 SecurityInvalidAzureKeyVaultRecoveryLevel : l’URI Key Vault fourni n’est pas valide. 400 KeyMaterialNotFoundOnRemoteServer : le serveur distant n’a pas accès au matériel de clé utilisé comme protecteur TDE. 400 AzureKeyVaultRsaKeyNotSupported : le coffre de clés fourni utilise une taille de clé RSA ou un type de clé non pris en charge. La taille de clé RSA prise en charge est 2048 ou 3072 et le type de clé est RSA ou RSA-HSM. 400 AzureKeyVaultKeyDisabled : l’opération n’a pas pu être effectuée sur le serveur, car la clé Azure Key Vault est désactivée. 400 AzureKeyVaultInvalidExpirationDate : l’opération n’a pas pu être terminée, car la date d’expiration de la clé Azure Key Vault n’est pas valide. 400 SameKeyUriNotFoundOnRemoteServer : le serveur secondaire n’a pas le matériel de clé du même coffre de clés que le protecteur de chiffrement du serveur principal avec la rotation automatique des clés activée. 400 SecurityAzureKeyVaultUrlNullOrEmpty : l’opération n’a pas pu être effectuée, car l’URI azure Key Vault est null ou vide. 400 SameKeyMaterialNotFoundOnRemoteServer : le serveur secondaire n’a pas le matériel de clé du protecteur de chiffrement du serveur principal. 400 PerDatabaseCMKRestoreNotSupported : la restauration de base de données n’est pas prise en charge lorsque la clé CMK au niveau de la base de données est configurée en préversion. 400 AzureKeyVaultNoServerIdentity : l’identité du serveur n’est pas correctement configurée. 400 PerDatabaseCMKHSNotSupported : cmk au niveau de la base de données en préversion n’est pas pris en charge pour l’édition Hyperscale. 400 AzureKeyVaultInvalidUri : réponse non valide d’Azure Key Vault. Utilisez un URI de Key Vault Azure valide. 400 AzureKeyVaultMissingPermissions : le serveur n’a pas les autorisations requises sur le Key Vault Azure. 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId fourni par l’utilisateur n’a pas accès à KeyId fourni 400 AkvEndpointNotReachableFromNode : le point de terminaison AKV «{0} » n’est pas accessible à partir de SQL, sur le serveur « ».{1} 400 SecurityAzureKeyVaultInvalidKeyName : l’opération n’a pas pu être effectuée en raison d’un nom de clé de serveur non valide. 400 AdalGenericError : l’opération n’a pas pu être terminée, car une erreur Azure Active Directory a été rencontrée. 400 AdalServicePrincipalNotFound : l’opération n’a pas pu être terminée, car une erreur de principal de service introuvable dans la bibliothèque Azure Active Directory a été rencontrée. 400 AzureKeyVaultMalformedVaultUri : l’URI de Key Vault fourni n’est pas valide. 400 SecurityAzureKeyVaultGeoChainError : la création d’un composant secondaire (un processus appelé chaînage) n’est pas prise en charge lors de l’activation de Transparent Data Encryption à l’aide d’Azure Key Vault (BYOK). 400 PerDatabaseCMKDWNotSupported : la clé CMK au niveau de la base de données en préversion n’est pas prise en charge pour l’édition Datawarehouse. 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. 404 ResourceNotFound : la ressource demandée est introuvable. 404 OperationIdNotFound : l’opération avec ID n’existe pas. 409 ServerKeyNameAlreadyExists : la clé de serveur existe déjà sur le serveur. 409 ServerKeyUriAlreadyExists : l’URI de clé de serveur existe déjà sur le serveur. 409 ServerKeyDoesNotExists - la clé du serveur n’existe pas. 409 AzureKeyVaultKeyNameNotFound : l’opération n’a pas pu être effectuée, car le nom de la clé Azure Key Vault n’existe pas. 409 AzureKeyVaultKeyInUse : la clé est actuellement utilisée par le serveur. 409 ServerKeyNameAlreadyExists : la clé de serveur existe déjà sur le serveur. 409 ServerKeyUriAlreadyExists : l’URI de clé de serveur existe déjà sur le serveur. 409 ServerKeyDoesNotExists - la clé du serveur n’existe pas. 409 AzureKeyVaultKeyNameNotFound : l’opération n’a pas pu être effectuée, car le nom de la clé Azure Key Vault n’existe pas. 409 AzureKeyVaultKeyInUse : la clé est actuellement utilisée par le serveur. 409 OperationCancelled : l’opération a été annulée par l’utilisateur. 409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource. 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 500 OperationTimedOut : l’opération a expiré et a été automatiquement restaurée. Réessayez l’opération. 503 AzureKeyVaultConnectionFailed : l’opération n’a pas pu être effectuée sur le serveur, car les tentatives de connexion à Azure Key Vault ont échoué 503 AzureKeyVaultGenericConnectionError : l’opération n’a pas pu être terminée, car une erreur a été rencontrée lors de la tentative de récupération des informations Key Vault . 503 AzureKeyVaultConnectionFailed : l’opération n’a pas pu être effectuée sur le serveur, car les tentatives de connexion à Azure Key Vault ont échoué 503 AzureKeyVaultGenericConnectionError : l’opération n’a pas pu être terminée, car une erreur a été rencontrée lors de la tentative de récupération des informations Key Vault . 503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.

Exemples

Creates or updates a server key

PUT 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=2021-11-01

{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
  }
}


import com.azure.resourcemanager.sql.fluent.models.ServerKeyInner;
import com.azure.resourcemanager.sql.models.ServerKeyType;

/**
 * Samples for ServerKeys CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerKeyCreateOrUpdate.json
     */
    /**
     * Sample code: Creates or updates a server key.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createsOrUpdatesAServerKey(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerKeys().createOrUpdate("sqlcrudtest-7398",
            "sqlcrudtest-4645", "someVault_someKey_01234567890123456789012345678901",
            new ServerKeyInner().withServerKeyType(ServerKeyType.AZURE_KEY_VAULT)
                .withUri("https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"),
            com.azure.core.util.Context.NONE);
    }
}

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

Code d’état:: 201

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

Code d’état:: 202

Définitions

Nom	Description
ServerKey	Une clé de serveur.
ServerKeyType	Type de clé de serveur comme « ServiceManaged », « AzureKeyVault ».

ServerKey

Une 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’activation de la rotation automatique des clés. 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 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

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

Nom	Type	Description
AzureKeyVault	string
ServiceManaged	string

Partager via