Keys interface
Интерфейс, представляющий ключи.
Методы
| create |
Создает первую версию нового ключа, если его не существует. Если он уже существует, существующий ключ возвращается без выполнения операций записи. Этот API не создает последующие версии и не обновляет существующие ключи. |
| get(string, string, string, Keys |
Возвращает текущую версию указанного ключа из указанного хранилища ключей. |
| get |
Возвращает указанную версию указанного ключа в указанном хранилище ключей. |
| list(string, string, Keys |
Выводит список ключей в указанном хранилище ключей. |
| list |
Список версий указанного ключа в указанном хранилище ключей. |
Сведения о методе
createIfNotExist(string, string, string, KeyCreateParameters, KeysCreateIfNotExistOptionalParams)
Создает первую версию нового ключа, если его не существует. Если он уже существует, существующий ключ возвращается без выполнения операций записи. Этот API не создает последующие версии и не обновляет существующие ключи.
function createIfNotExist(resourceGroupName: string, vaultName: string, keyName: string, parameters: KeyCreateParameters, options?: KeysCreateIfNotExistOptionalParams): Promise<Key>Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей указанное хранилище ключей.
- vaultName
-
string
Имя хранилища ключей, содержащего ключ для создания.
- keyName
-
string
Имя создаваемого ключа. Указанное значение может быть скопировано глобально для запуска службы. Указываемое значение не должно включать личную или конфиденциальную информацию.
- parameters
- KeyCreateParameters
Параметры, используемые для создания указанного ключа.
Параметры параметров.
Возвращаемое значение
Promise<Key>
get(string, string, string, KeysGetOptionalParams)
Возвращает текущую версию указанного ключа из указанного хранилища ключей.
function get(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysGetOptionalParams): Promise<Key>Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей указанное хранилище ключей.
- vaultName
-
string
Имя хранилища, содержащего ключ для извлечения.
- keyName
-
string
Имя извлекаемого ключа.
- options
- KeysGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<Key>
getVersion(string, string, string, string, KeysGetVersionOptionalParams)
Возвращает указанную версию указанного ключа в указанном хранилище ключей.
function getVersion(resourceGroupName: string, vaultName: string, keyName: string, keyVersion: string, options?: KeysGetVersionOptionalParams): Promise<Key>Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей указанное хранилище ключей.
- vaultName
-
string
Имя хранилища, которое содержит версию ключа для извлечения.
- keyName
-
string
Имя извлекаемой версии ключа.
- keyVersion
-
string
Версия извлекаемого ключа.
- options
- KeysGetVersionOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<Key>
list(string, string, KeysListOptionalParams)
Выводит список ключей в указанном хранилище ключей.
function list(resourceGroupName: string, vaultName: string, options?: KeysListOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей указанное хранилище ключей.
- vaultName
-
string
Имя хранилища, содержащего извлекаемые ключи.
- options
- KeysListOptionalParams
Параметры параметров.
Возвращаемое значение
listVersions(string, string, string, KeysListVersionsOptionalParams)
Список версий указанного ключа в указанном хранилище ключей.
function listVersions(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysListVersionsOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов, содержащей указанное хранилище ключей.
- vaultName
-
string
Имя хранилища, которое содержит версии ключей для извлечения.
- keyName
-
string
Имя извлекаемых версий ключей.
- options
- KeysListVersionsOptionalParams
Параметры параметров.