Server Keys - Create Or Update

Odwołanie

Usługa:: SQL Database

Wersja interfejsu API:: 2021-11-01

Tworzy lub aktualizuje klucz serwera.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
keyName	path	True	string	Nazwa klucza serwera, który ma być obsługiwany (zaktualizowany lub utworzony). Nazwa klucza musi być w formacie "vault_key_version". Jeśli na przykład parametr keyId to https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, nazwa klucza serwera powinna być sformatowana jako: YourVaultName_YourKeyName_YourKeyVersion
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties.serverKeyType	True	ServerKeyType	Typ klucza serwera, taki jak "ServiceManaged", "AzureKeyVault".
properties.uri		string	Identyfikator URI klucza serwera. Jeśli parametr ServerKeyType to AzureKeyVault, wymagany jest identyfikator URI. Identyfikator URI usługi AKV musi mieć następujący format: "https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion"

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ServerKey	Pomyślnie zaktualizowano klucz serwera.
201 Created	ServerKey	Pomyślnie utworzono klucz serwera.
202 Accepted		Zaakceptowano
Other Status Codes		Odpowiedzi na błędy: *** 400 InvalidKeyName — podano nieprawidłową wartość dla nazwy klucza serwera. 400 InvalidKeyType — typ klucza serwera tworzenia nie jest obsługiwany. 400 InvalidUpsertKeyType — klucze TDE zarządzane przez usługę są zarządzane przez usługę. Klucze TDE zarządzane przez usługę nie obsługują tworzenia ani aktualizowania przez użytkownika. 400 InvalidKeyUpsertRequest — żądanie tworzenia klucza serwera nie istnieje lub nie ma obiektu właściwości. 400 SecurityAdalPrincipalCertExpiredError — nie można ukończyć operacji, ponieważ certyfikat główny usługi Azure Key Vault wygasł. 400 AkvHostNotResolvingFromNode — host AKV "{0}" nie jest rozpoznawalny z programu SQL na serwerze "{1}". 400 SecurityInvalidAzureKeyVaultRecoveryLevel — podany identyfikator URI Key Vault jest nieprawidłowy. 400 KeyMaterialNotFoundOnRemoteServer — serwer zdalny nie ma dostępu do materiału klucza używanego jako funkcja ochrony TDE. 400 AzureKeyVaultRsaKeyNotSupported — podany magazyn kluczy używa nieobsługiwanego rozmiaru klucza RSA lub typu klucza. Obsługiwany rozmiar klucza RSA to 2048 lub 3072, a typ klucza to RSA lub RSA-HSM. 400 AzureKeyVaultKeyDisabled — nie można ukończyć operacji na serwerze, ponieważ klucz usługi Azure Key Vault jest wyłączony. 400 AzureKeyVaultInvalidExpirationDate — nie można ukończyć operacji, ponieważ data wygaśnięcia klucza usługi Azure Key Vault jest nieprawidłowa. 400 SameKeyUriNotFoundOnRemoteServer — serwer pomocniczy nie ma materiału klucza z tego samego magazynu kluczy, co funkcja ochrony szyfrowania serwera podstawowego z włączonym automatycznym obracania klucza. 400 SecurityAzureKeyVaultUrlNullOrEmpty — nie można ukończyć operacji, ponieważ identyfikator URI usługi Azure Key Vault ma wartość null lub jest pusty. 400 SameKeyMaterialNotFoundOnRemoteServer — serwer pomocniczy nie ma materiału klucza ochrony szyfrowania serwera podstawowego. 400 PerDatabaseCMKRestoreNotSupported — przywracanie bazy danych nie jest obsługiwane w przypadku skonfigurowania klucza zarządzanego na poziomie bazy danych w wersji zapoznawczej. 400 AzureKeyVaultNoServerIdentity — tożsamość serwera nie jest poprawnie skonfigurowana. 400 PerDatabaseCMKHSNotSupported — klucz cmK na poziomie bazy danych w wersji zapoznawczej nie jest obsługiwany w przypadku wersji Hiperskala. 400 AzureKeyVaultInvalidUri — nieprawidłowa odpowiedź z usługi Azure Key Vault. Użyj prawidłowego identyfikatora URI usługi Azure Key Vault. 400 AzureKeyVaultMissingPermissions — na serwerze brakuje wymaganych uprawnień w usłudze Azure Key Vault. 400 UmiMissingAkvPermissions — PrimaryUserAssignedIdentityId podany przez użytkownika nie ma dostępu do podanego identyfikatora KeyId 400 AkvEndpointNotReachableFromNode — punkt końcowy USŁUGI AKV "{0}" nie jest osiągalny z bazy danych SQL na serwerze "{1}". 400 SecurityAzureKeyVaultInvalidKeyName — nie można ukończyć operacji z powodu nieprawidłowej nazwy klucza serwera. 400 AdalGenericError — nie można ukończyć operacji, ponieważ wystąpił błąd usługi Azure Active Directory. 400 AdalServicePrincipalNotFound — nie można ukończyć operacji, ponieważ napotkano błąd jednostki usługi biblioteki Azure Active Directory. 400 AzureKeyVaultMalformedVaultUri — podany identyfikator URI Key Vault jest nieprawidłowy. 400 SecurityAzureKeyVaultGeoChainError — tworzenie pomocniczej metody pomocniczej (procesu znanego jako łańcuch) nie jest obsługiwane w przypadku włączania funkcji Transparent Data Encryption przy użyciu usługi Azure Key Vault (BYOK). 400 PerDatabaseCMKDWNotSupported — klucz cmK na poziomie bazy danych w wersji zapoznawczej nie jest obsługiwany w przypadku wersji datawarehouse. 400 SecurityAdalPrincipalCertExpiredError — nie można ukończyć operacji, ponieważ certyfikat główny usługi Azure Key Vault wygasł. 400 AkvHostNotResolvingFromNode — host AKV "{0}" nie jest rozpoznawalny z programu SQL na serwerze "{1}". 400 SecurityInvalidAzureKeyVaultRecoveryLevel — podany identyfikator URI Key Vault jest nieprawidłowy. 400 KeyMaterialNotFoundOnRemoteServer — serwer zdalny nie ma dostępu do materiału klucza używanego jako funkcja ochrony TDE. 400 AzureKeyVaultRsaKeyNotSupported — podany magazyn kluczy używa nieobsługiwanego rozmiaru klucza RSA lub typu klucza. Obsługiwany rozmiar klucza RSA to 2048 lub 3072, a typ klucza to RSA lub RSA-HSM. 400 AzureKeyVaultKeyDisabled — nie można ukończyć operacji na serwerze, ponieważ klucz usługi Azure Key Vault jest wyłączony. 400 AzureKeyVaultInvalidExpirationDate — nie można ukończyć operacji, ponieważ data wygaśnięcia klucza usługi Azure Key Vault jest nieprawidłowa. 400 SameKeyUriNotFoundOnRemoteServer — serwer pomocniczy nie ma materiału klucza z tego samego magazynu kluczy, co funkcja ochrony szyfrowania serwera podstawowego z włączonym automatycznym obracania klucza. 400 SecurityAzureKeyVaultUrlNullOrEmpty — nie można ukończyć operacji, ponieważ identyfikator URI usługi Azure Key Vault ma wartość null lub jest pusty. 400 SameKeyMaterialNotFoundOnRemoteServer — serwer pomocniczy nie ma materiału klucza ochrony szyfrowania serwera podstawowego. 400 PerDatabaseCMKRestoreNotSupported — przywracanie bazy danych nie jest obsługiwane w przypadku skonfigurowania klucza zarządzanego na poziomie bazy danych w wersji zapoznawczej. 400 AzureKeyVaultNoServerIdentity — tożsamość serwera nie jest poprawnie skonfigurowana. 400 PerDatabaseCMKHSNotSupported — klucz cmK na poziomie bazy danych w wersji zapoznawczej nie jest obsługiwany w przypadku wersji Hiperskala. 400 AzureKeyVaultInvalidUri — nieprawidłowa odpowiedź z usługi Azure Key Vault. Użyj prawidłowego identyfikatora URI usługi Azure Key Vault. 400 AzureKeyVaultMissingPermissions — na serwerze brakuje wymaganych uprawnień w usłudze Azure Key Vault. 400 UmiMissingAkvPermissions — PrimaryUserAssignedIdentityId podany przez użytkownika nie ma dostępu do podanego identyfikatora KeyId 400 AkvEndpointNotReachableFromNode — punkt końcowy USŁUGI AKV "{0}" nie jest osiągalny z bazy danych SQL na serwerze "{1}". 400 SecurityAzureKeyVaultInvalidKeyName — nie można ukończyć operacji z powodu nieprawidłowej nazwy klucza serwera. 400 AdalGenericError — nie można ukończyć operacji, ponieważ wystąpił błąd usługi Azure Active Directory. 400 AdalServicePrincipalNotFound — nie można ukończyć operacji, ponieważ napotkano błąd jednostki usługi biblioteki Azure Active Directory. 400 AzureKeyVaultMalformedVaultUri — podany identyfikator URI Key Vault jest nieprawidłowy. 400 SecurityAzureKeyVaultGeoChainError — tworzenie pomocniczej metody pomocniczej (procesu znanego jako łańcuch) nie jest obsługiwane w przypadku włączania funkcji Transparent Data Encryption przy użyciu usługi Azure Key Vault (BYOK). 400 PerDatabaseCMKDWNotSupported — klucz cmK na poziomie bazy danych w wersji zapoznawczej nie jest obsługiwany w przypadku wersji datawarehouse. 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera 404 ServerNotInSubscriptionResourceGroup — określony serwer nie istnieje w określonej grupie zasobów i subskrypcji. 404 ResourceNotFound — żądany zasób nie został znaleziony. 404 OperationIdNotFound — operacja o identyfikatorze nie istnieje. 409 ServerKeyNameAlreadyExists — klucz serwera już istnieje na serwerze. 409 ServerKeyUriAlreadyExists — identyfikator URI klucza serwera już istnieje na serwerze. 409 ServerKeyDoesNotExists — klucz serwera nie istnieje. 409 AzureKeyVaultKeyNameNotFound — nie można ukończyć operacji, ponieważ nazwa klucza usługi Azure Key Vault nie istnieje. 409 AzureKeyVaultKeyInUse — klucz jest obecnie używany przez serwer. 409 ServerKeyNameAlreadyExists — klucz serwera już istnieje na serwerze. 409 ServerKeyUriAlreadyExists — identyfikator URI klucza serwera już istnieje na serwerze. 409 ServerKeyDoesNotExists — klucz serwera nie istnieje. 409 AzureKeyVaultKeyNameNotFound — nie można ukończyć operacji, ponieważ nazwa klucza usługi Azure Key Vault nie istnieje. 409 AzureKeyVaultKeyInUse — klucz jest obecnie używany przez serwer. 409 OperationCancelled — operacja została anulowana przez użytkownika. 409 Operacja przerwana — nie można ukończyć operacji na zasobie, ponieważ została przerwana przez inną operację na tym samym zasobie. 429 SubscriptionTooManyCreateUpdateRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby. 429 SubscriptionTooManyRequests — żądania wykraczające poza maksymalną liczbę żądań, które mogą być przetwarzane przez dostępne zasoby. 500 OperationTimedOut — upłynął limit czasu operacji i automatycznie wycofano. Ponów próbę wykonania operacji. 503 AzureKeyVaultConnectionFailed — nie można ukończyć operacji na serwerze, ponieważ próby nawiązania połączenia z usługą Azure Key Vault zakończyły się niepowodzeniem 503 AzureKeyVaultGenericConnectionError — nie można ukończyć operacji, ponieważ wystąpił błąd podczas próby pobrania Key Vault informacji. 503 AzureKeyVaultConnectionFailed — nie można ukończyć operacji na serwerze, ponieważ próby nawiązania połączenia z usługą Azure Key Vault zakończyły się niepowodzeniem 503 AzureKeyVaultGenericConnectionError — nie można ukończyć operacji, ponieważ wystąpił błąd podczas próby pobrania Key Vault informacji. 503 TooManyRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby.

Przykłady

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

Przykładowa odpowiedź

Kod stanu:: 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
  }
}

Kod stanu:: 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
  }
}

Kod stanu:: 202

Definicje

Nazwa	Opis
ServerKey	Klucz serwera.
ServerKeyType	Typ klucza serwera, taki jak "ServiceManaged", "AzureKeyVault".

ServerKey

Klucz serwera.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj ochrony szyfrowania. Są to metadane używane w środowisku Azure Portal.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties.autoRotationEnabled	boolean	Flaga zgody na automatyczne obracanie kluczy. Prawda lub fałsz.
properties.creationDate	string	Data utworzenia klucza serwera.
properties.serverKeyType	ServerKeyType	Typ klucza serwera, taki jak "ServiceManaged", "AzureKeyVault".
properties.subregion	string	Podregion klucza serwera.
properties.thumbprint	string	Odcisk palca klucza serwera.
properties.uri	string	Identyfikator URI klucza serwera. Jeśli parametr ServerKeyType to AzureKeyVault, wymagany jest identyfikator URI. Identyfikator URI usługi AKV musi mieć następujący format: "https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion"
type	string	Typ zasobu.

ServerKeyType

Typ klucza serwera, taki jak "ServiceManaged", "AzureKeyVault".

Nazwa	Typ	Opis
AzureKeyVault	string
ServiceManaged	string

Udostępnij za pośrednictwem