Поделиться через


Encryption Protectors - List By Server

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

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

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.

serverName
path True

string

Имя сервера.

subscriptionId
path True

string

Идентификатор подписки, идентифицирующий подписку Azure.

api-version
query True

string

Версия API, используемая для запроса.

Ответы

Имя Тип Описание
200 OK

EncryptionProtectorListResult

Успешно получен список средств защиты шифрования сервера.

Other Status Codes

ErrorResponse

Ответы на ошибки: ***

  • 400 ManagedInstanceStoppingOrStoppingOrStopped — конфликтующая операция, отправленная во время остановки или остановки экземпляра

  • 400 ManagedInstanceStarting — конфликтующая операция, отправленная во время запуска экземпляра

  • 400 InvalidKeyName — недопустимое значение было задано для имени ключа сервера.

  • 400 InvalidKeyType — тип ключа сервера create не поддерживается.

  • 400 InvalidUpsertKeyType — ключи TDE, управляемые службой, управляются службой. Ключи TDE, управляемые службой, не поддерживают создание или обновление пользователем.

  • 400 InvalidKeyUpsertRequest — запрос на создание ключа сервера не существует или не имеет объекта свойств.

  • 400 InvalidEncryptionProtectorName — имя ключа защиты шифрования не поддерживается.

  • 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке.

  • 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден

Примеры

List encryption protectors by server

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

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

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

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

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

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Ответ на ошибку

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[]

Массив результатов.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

ServerKeyType

Тип защиты шифрования, например ServiceManaged, AzureKeyVault.

Значение Описание
ServiceManaged
AzureKeyVault