Encryption Protectors - List By Server

Служба:

SQL Database

Версия API:

2021-11-01

Возвращает список средств защиты шифрования сервера.

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

Параметры URI

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

Ответы

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

Примеры

List encryption protectors by server

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

HTTP

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

Java

/**
 * Samples for EncryptionProtectors ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/EncryptionProtectorList.json
     */
    /**
     * Sample code: List encryption protectors by server.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listEncryptionProtectorsByServer(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getEncryptionProtectors().listByServer("sqlcrudtest-7398",
            "sqlcrudtest-4645", 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

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current",
      "name": "current",
      "type": "Microsoft.Sql/servers/encryptionProtector",
      "location": "Japan East",
      "kind": "azurekeyvault",
      "properties": {
        "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
        "serverKeyType": "AzureKeyVault",
        "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
      }
    }
  ]
}

Определения

Имя	Описание
EncryptionProtector	Предохранитель шифрования сервера.
EncryptionProtectorListResult	Список средств защиты шифрования сервера.
ServerKeyType	Тип предохранителя шифрования, например ServiceManaged, AzureKeyVault.

EncryptionProtector

Предохранитель шифрования сервера.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
kind	string	Тип предохранителя шифрования. Это метаданные, используемые для портал Azure взаимодействия.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.autoRotationEnabled	boolean	Флаг автоматического поворота ключей. Либо true, либо false.
properties.serverKeyName	string	Имя ключа сервера.
properties.serverKeyType	ServerKeyType	Тип предохранителя шифрования, например ServiceManaged, AzureKeyVault.
properties.subregion	string	Подобласть предохранителя шифрования.
properties.thumbprint	string	Отпечаток ключа сервера.
properties.uri	string	Универсальный код ресурса (URI) ключа сервера.
type	string	Тип ресурса.

EncryptionProtectorListResult

Список средств защиты шифрования сервера.

Имя	Тип	Описание
nextLink	string	Ссылка для получения следующей страницы результатов.
value	EncryptionProtector[]	Массив результатов.

ServerKeyType

Тип предохранителя шифрования, например ServiceManaged, AzureKeyVault.

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