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


Server Keys - Get

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

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

Параметры URI

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

string

Имя извлекаемого ключа сервера.

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

ServerKey

Успешно получен указанный ключ сервера.

Other Status Codes

ErrorResponse

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

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

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

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

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

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

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

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

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

  • 404 ResourceNotFound — запрошенный ресурс не найден.

Примеры

Get the server key

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

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=2023-08-01

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

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

Определения

Имя Описание
ErrorAdditionalInfo

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

ErrorDetail

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

ErrorResponse

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

ServerKey

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

ServerKeyType

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

ErrorAdditionalInfo

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

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

object

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

type

string

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

ErrorDetail

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

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

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

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

target

string

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

ErrorResponse

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

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

ErrorDetail

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

ServerKey

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

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

string

Идентификатор ресурса.

kind

string

Тип защиты шифрования. Это метаданные, используемые для интерфейса портала Azure.

location

string

Расположение ресурса.

name

string

Имя ресурса.

properties.autoRotationEnabled

boolean

Флаг автоматического поворота клавиши. Значение true или false.

properties.creationDate

string (date-time)

Дата создания ключа сервера.

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
ServiceManaged