Managed Instance Keys - Get

Служба:

SQL Database

Версия API:

2021-11-01

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

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

Параметры URI

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

Ответы

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

Примеры

Get the managed instance key

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

HTTP

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

Java

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

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/managedInstances/keys",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2020-11-01T00:00:00Z",
    "autoRotationEnabled": false
  }
}

Определения

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

ManagedInstanceKey

Object

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

Имя	Тип	Описание
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	Тип ресурса.

ServerKeyType

Enumeration

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

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