Managed Instance Keys - List By Instance

Service:

SQL Database

API Version:

2021-11-01

Возвращает список ключей управляемого экземпляра.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/keys?$filter={$filter}&api-version=2021-11-01

Параметры URI

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

Ответы

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

Примеры

List the keys for a managed instance.

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for ManagedInstanceKeys ListByInstance. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedInstanceKeyList.json
     */
    /**
     * Sample code: List the keys for a managed instance.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listTheKeysForAManagedInstance(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstanceKeys().listByInstance("sqlcrudtest-7398",
            "sqlcrudtest-4645", null, 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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
      "name": "someVault_someKey_01234567890123456789012345678901",
      "type": "Microsoft.Sql/managedInstances/keys",
      "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/managedInstances/sqlcrudtest-4645/keys/myVault_myKey_11111111111111111111111111111111",
      "name": "myVault_myKey_11111111111111111111111111111111",
      "type": "Microsoft.Sql/managedInstances/keys",
      "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/managedInstances/sqlcrudtest-4645/keys/ServiceManaged",
      "name": "ServiceManaged",
      "type": "Microsoft.Sql/managedInstances/keys",
      "kind": "servicemanaged",
      "properties": {}
    }
  ]
}

Определения

Имя	Описание
ManagedInstanceKey	Ключ управляемого экземпляра.
ManagedInstanceKeyListResult	Список ключей управляемого экземпляра.
ServerKeyType	Тип ключа, например ServiceManaged, AzureKeyVault.

ManagedInstanceKey

Ключ управляемого экземпляра.

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

ManagedInstanceKeyListResult

Список ключей управляемого экземпляра.

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

ServerKeyType

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

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