Server Keys - Create Or Update
Tworzy lub aktualizuje klucz serwera.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/keys/{keyName}?api-version=2025-01-01
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
key
|
path | True |
string |
Nazwa klucza serwera do działania (zaktualizowana lub utworzona). Nazwa klucza musi być w formacie "vault_key_version". Jeśli na przykład keyId ma wartość |
|
resource
|
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. |
|
server
|
path | True |
string |
Nazwa serwera. |
|
subscription
|
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 |
Typ klucza serwera, taki jak "ServiceManaged", "AzureKeyVault". |
|
| properties.uri |
string |
Identyfikator URI klucza serwera. Jeśli wartość ServerKeyType to AzureKeyVault, wymagany jest identyfikator URI. Identyfikator URI AKV musi być w tym formacie: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' lub może być 'https://YourVaultName.vault.azure.net/keys/YourKeyName' |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
Pomyślnie zaktualizowano klucz serwera. |
|
| 201 Created |
Pomyślnie utworzono klucz serwera. |
|
| 202 Accepted |
Zaakceptowano Nagłówki Location: string |
|
| Other Status Codes |
Odpowiedzi na błędy: ***
|
Przykłady
| Creates or updates a server key |
| Creates or updates a server key with versionless key |
Creates or updates a server key
Przykładowe żądanie
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=2025-01-01
{
"properties": {
"serverKeyType": "AzureKeyVault",
"uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
}
}
Przykładowa odpowiedź
{
"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": "2024-11-15T00:00:00Z"
}
}
{
"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": "2024-11-15T00:00:00Z"
}
}
Creates or updates a server key with versionless key
Przykładowe żądanie
PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey?api-version=2025-01-01
{
"properties": {
"serverKeyType": "AzureKeyVault",
"uri": "https://someVault.vault.azure.net/keys/someKey"
}
}
Przykładowa odpowiedź
{
"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": "2024-11-15T00:00:00Z"
}
}
{
"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": "2024-11-15T00:00:00Z"
}
}
Definicje
| Nazwa | Opis |
|---|---|
|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
|
Error |
Szczegóły błędu. |
|
Error |
Odpowiedź na błąd |
|
Server |
Klucz serwera. |
|
Server |
Typ klucza serwera, taki jak "ServiceManaged", "AzureKeyVault". |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
| Nazwa | Typ | Opis |
|---|---|---|
| info |
object |
Dodatkowe informacje. |
| type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
| Nazwa | Typ | Opis |
|---|---|---|
| additionalInfo |
Błąd dodatkowe informacje. |
|
| code |
string |
Kod błędu. |
| details |
Szczegóły błędu. |
|
| message |
string |
Komunikat o błędzie. |
| target |
string |
Cel błędu. |
ErrorResponse
Odpowiedź na błąd
| Nazwa | Typ | Opis |
|---|---|---|
| error |
Obiekt błędu. |
ServerKey
Klucz serwera.
| Nazwa | Typ | Opis |
|---|---|---|
| id |
string |
Identyfikator zasobu. |
| kind |
string |
Rodzaj ochrony szyfrowania. Są to metadane używane w środowisku witryny Azure Portal. |
| location |
string |
Lokalizacja zasobu. |
| name |
string |
Nazwa zasobu. |
| properties.autoRotationEnabled |
boolean |
Flaga automatycznego obracania kluczy. Prawda lub fałsz. |
| properties.creationDate |
string (date-time) |
Data utworzenia klucza serwera. |
| properties.keyVersion |
string |
Wersja klucza serwera. |
| properties.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 wartość ServerKeyType to AzureKeyVault, wymagany jest identyfikator URI. Identyfikator URI AKV musi być w tym formacie: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' lub może być 'https://YourVaultName.vault.azure.net/keys/YourKeyName' |
| type |
string |
Typ zasobu. |
ServerKeyType
Typ klucza serwera, taki jak "ServiceManaged", "AzureKeyVault".
| Wartość | Opis |
|---|---|
| ServiceManaged | |
| AzureKeyVault |