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
选项参数。