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
選項參數。