Server Keys - List By Server

  • Ссылка
Служба:
SQL Database
Версия API:
2021-11-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/keys?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

ServerKeyListResult

Список ключей сервера успешно получен.
Other Status Codes

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

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

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

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

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

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

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

Примеры

List the server keys by server

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

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

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

Код состояния:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
      "name": "someVault_someKey_01234567890123456789012345678901",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "kind": "azurekeyvault",
      "properties": {
        "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
        "creationDate": "2020-11-15T00:00:00Z",
        "autoRotationEnabled": false
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/myVault_myKey_11111111111111111111111111111111",
      "name": "myVault_myKey_11111111111111111111111111111111",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "kind": "azurekeyvault",
      "properties": {
        "thumbprint": "AAAAAAAAAAAAAAABBBBBBBBBBBBBBBBBBBBBBBBB",
        "creationDate": "2020-11-15T00:00:00Z",
        "autoRotationEnabled": false
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/ServiceManaged",
      "name": "ServiceManaged",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "kind": "servicemanaged",
      "properties": {}
    }
  ]
}

Определения

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

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

Список ключей сервера.
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

Тип ресурса.

ServerKeyListResult

Список ключей сервера.

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

string

Ссылка для получения следующей страницы результатов.
value

ServerKey[]

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

ServerKeyType

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

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

string

ServiceManaged

string