你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
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
选项参数。