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
オプション パラメーター。