次の方法で共有

Keys interface

  • リファレンス
パッケージ:
@azure/arm-keyvault

キーを表すインターフェイス。

メソッド

createIfNotExist(string, string, string, KeyCreateParameters, KeysCreateIfNotExistOptionalParams)

新しいキーの最初のバージョンが存在しない場合、それを作成します。 既に存在する場合は、書き込み操作を実行せずに既存のキーが返されます。 この API は、後続のバージョンを作成したり、既存のキーを更新したりしません。
get(string, string, string, KeysGetOptionalParams)

指定したキー コンテナーから、指定したキーの現在のバージョンを取得します。
getVersion(string, string, string, string, KeysGetVersionOptionalParams)

指定したキー コンテナー内の指定したキーの指定したバージョンを取得します。
list(string, string, KeysListOptionalParams)

指定したキー コンテナー内のキーを一覧表示します。
listVersions(string, string, string, KeysListVersionsOptionalParams)

指定したキー コンテナー内の指定したキーのバージョンを一覧表示します。

メソッドの詳細

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

指定したキーの作成に使用されるパラメーター。

options
KeysCreateIfNotExistOptionalParams

options パラメーター。

戻り値

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

options パラメーター。

戻り値

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

options パラメーター。

戻り値

Promise<Key>

list(string, string, KeysListOptionalParams)

指定したキー コンテナー内のキーを一覧表示します。

function list(resourceGroupName: string, vaultName: string, options?: KeysListOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>

パラメーター

resourceGroupName

string

指定したキー コンテナーを含むリソース グループの名前。

vaultName

string

取得するキーを含むコンテナーの名前。

options
KeysListOptionalParams

options パラメーター。

戻り値

PagedAsyncIterableIterator<Key, Key[], PageSettings>

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

options パラメーター。

戻り値

PagedAsyncIterableIterator<Key, Key[], PageSettings>