Server Keys - Get

Служба:

SQL Database

Версия API:

2021-11-01

Возвращает ключ сервера.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
keyName	path	True	string	Имя извлекаемого ключа сервера.
resourceGroupName	path	True	string	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования в запросе.

Ответы

Имя	Тип	Описание
200 OK	ServerKey	Указанный ключ сервера успешно получен.
Other Status Codes		Ответы на ошибки: *** 400 InvalidKeyName — для имени ключа сервера было присвоено недопустимое значение. 400 InvalidKeyType — тип ключа сервера создания не поддерживается. 400 InvalidUpsertKeyType — управляемые службой ключи TDE управляются службой. Управляемые службой ключи TDE не поддерживают создание или обновление пользователем. 400 InvalidKeyUpsertRequest — запрос на создание ключа сервера не существует или не имеет объекта свойств. 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке. 404 ResourceNotFound — запрошенный ресурс не найден.

Примеры

Get the server key

Образец запроса

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

Java

/**
 * Samples for ServerKeys Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerKeyGet.json
     */
    /**
     * Sample code: Get the server key.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getTheServerKey(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerKeys().getWithResponse("sqlcrudtest-7398",
            "sqlcrudtest-4645", "someVault_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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
ServerKey	Ключ сервера.
ServerKeyType	Тип ключа сервера, например ServiceManaged, AzureKeyVault.

ServerKey

Ключ сервера.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
kind	string	Тип предохранителя шифрования. Это метаданные, используемые для портал Azure взаимодействия.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.autoRotationEnabled	boolean	Флаг автоматического поворота ключей. Либо true, либо false.
properties.creationDate	string	Дата создания ключа сервера.
properties.serverKeyType	ServerKeyType	Тип ключа сервера, например ServiceManaged, AzureKeyVault.
properties.subregion	string	Подобласть ключа сервера.
properties.thumbprint	string	Отпечаток ключа сервера.
properties.uri	string	Универсальный код ресурса (URI) ключа сервера. Если serverKeyType имеет значение AzureKeyVault, то требуется универсальный код ресурса (URI). URI AKV должен иметь следующий формат: "https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion"
type	string	Тип ресурса.

ServerKeyType

Тип ключа сервера, например ServiceManaged, AzureKeyVault.

Имя	Тип	Описание
AzureKeyVault	string
ServiceManaged	string