ManagedHsmKeys interface
代表 ManagedHsmKeys 的介面。
方法
| create |
如果新金鑰不存在，則會建立第一個版本。 如果已經存在，則會傳回現有的索引鍵，而不會執行任何寫入作業。 此 API 不會建立後續版本，也不會更新現有的金鑰。 |
| get(string, string, string, Managed |
從指定的 Managed HSM 取得指定金鑰的目前版本。 |
| get |
取得指定 Managed 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)
從指定的 Managed 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)
取得指定 Managed 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
要建立的金鑰名稱。 為了執行服務的目的，您可以全域複製您提供的值。 提供的值不應包含可識別個人的資訊或敏感性資訊。
選項參數。