你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
ManagedHsmKeys interface
表示 ManagedHsmKeys 的接口。
方法
| create |
创建新密钥的第一个版本（如果不存在）。 如果已存在，则会返回现有密钥，而无需执行任何写入操作。 此 API 不创建后续版本，也不更新现有的密钥。 |
| get(string, string, string, Managed |
从指定的托管 HSM 中获取指定密钥的当前版本。 |
| get |
获取指定托管 HSM 中指定密钥的指定版本。 |
| list(string, string, Managed |
列出指定的托管 HSM 中的密钥。 |
| list |
列出指定托管 HSM 中指定密钥的版本。 |
方法详细信息
createIfNotExist(string, string, string, ManagedHsmKeyCreateParameters, ManagedHsmKeysCreateIfNotExistOptionalParams)
创建新密钥的第一个版本（如果不存在）。 如果已存在，则会返回现有密钥，而无需执行任何写入操作。 此 API 不创建后续版本，也不更新现有的密钥。
function createIfNotExist(resourceGroupName: string, name: string, keyName: string, parameters: ManagedHsmKeyCreateParameters, options?: ManagedHsmKeysCreateIfNotExistOptionalParams): Promise<ManagedHsmKey>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
指定资源组中托管 HSM 池的名称。
- keyName
-
string
要创建的密钥的名称。 为了运行服务，可能会全局复制你提供的值。 提供的值不应包括个人身份信息或敏感信息。
- parameters
- ManagedHsmKeyCreateParameters
用于创建指定键的参数。
选项参数。
返回
Promise<ManagedHsmKey>
get(string, string, string, ManagedHsmKeysGetOptionalParams)
从指定的托管 HSM 中获取指定密钥的当前版本。
function get(resourceGroupName: string, name: string, keyName: string, options?: ManagedHsmKeysGetOptionalParams): Promise<ManagedHsmKey>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
指定资源组中托管 HSM 池的名称。
- keyName
-
string
要创建的密钥的名称。 为了运行服务，可能会全局复制你提供的值。 提供的值不应包括个人身份信息或敏感信息。
- options
- ManagedHsmKeysGetOptionalParams
选项参数。
返回
Promise<ManagedHsmKey>
getVersion(string, string, string, string, ManagedHsmKeysGetVersionOptionalParams)
获取指定托管 HSM 中指定密钥的指定版本。
function getVersion(resourceGroupName: string, name: string, keyName: string, keyVersion: string, options?: ManagedHsmKeysGetVersionOptionalParams): Promise<ManagedHsmKey>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
指定资源组中托管 HSM 池的名称。
- keyName
-
string
要创建的密钥的名称。 为了运行服务，可能会全局复制你提供的值。 提供的值不应包括个人身份信息或敏感信息。
- keyVersion
-
string
要检索的密钥的版本。
选项参数。
返回
Promise<ManagedHsmKey>
list(string, string, ManagedHsmKeysListOptionalParams)
列出指定的托管 HSM 中的密钥。
function list(resourceGroupName: string, name: string, options?: ManagedHsmKeysListOptionalParams): PagedAsyncIterableIterator<ManagedHsmKey, ManagedHsmKey[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
指定资源组中托管 HSM 池的名称。
- options
- ManagedHsmKeysListOptionalParams
选项参数。
返回
listVersions(string, string, string, ManagedHsmKeysListVersionsOptionalParams)
列出指定托管 HSM 中指定密钥的版本。
function listVersions(resourceGroupName: string, name: string, keyName: string, options?: ManagedHsmKeysListVersionsOptionalParams): PagedAsyncIterableIterator<ManagedHsmKey, ManagedHsmKey[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- name
-
string
指定资源组中托管 HSM 池的名称。
- keyName
-
string
要创建的密钥的名称。 为了运行服务，可能会全局复制你提供的值。 提供的值不应包括个人身份信息或敏感信息。
选项参数。