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
指定したリソース グループ内の Managed HSM プールの名前。
- keyName
-
string
作成するキーの名前。 指定した値は、サービスを実行するためにグローバルにコピーされる場合があります。 指定する値には、個人を特定できる情報や機密情報を含めてはなりません。
- parameters
- ManagedHsmKeyCreateParameters
指定したキーの作成に使用されるパラメーター。
options パラメーター。
戻り値
Promise<ManagedHsmKey>
get(string, string, string, ManagedHsmKeysGetOptionalParams)
指定したマネージド HSM から、指定したキーの現在のバージョンを取得します。
function get(resourceGroupName: string, name: string, keyName: string, options?: ManagedHsmKeysGetOptionalParams): Promise<ManagedHsmKey>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- name
-
string
指定したリソース グループ内の Managed HSM プールの名前。
- keyName
-
string
作成するキーの名前。 指定した値は、サービスを実行するためにグローバルにコピーされる場合があります。 指定する値には、個人を特定できる情報や機密情報を含めてはなりません。
- options
- ManagedHsmKeysGetOptionalParams
options パラメーター。
戻り値
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
指定したリソース グループ内の Managed HSM プールの名前。
- keyName
-
string
作成するキーの名前。 指定した値は、サービスを実行するためにグローバルにコピーされる場合があります。 指定する値には、個人を特定できる情報や機密情報を含めてはなりません。
- keyVersion
-
string
取得するキーのバージョン。
options パラメーター。
戻り値
Promise<ManagedHsmKey>
list(string, string, ManagedHsmKeysListOptionalParams)
指定したマネージド HSM のキーを一覧表示します。
function list(resourceGroupName: string, name: string, options?: ManagedHsmKeysListOptionalParams): PagedAsyncIterableIterator<ManagedHsmKey, ManagedHsmKey[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- name
-
string
指定したリソース グループ内の Managed HSM プールの名前。
- options
- ManagedHsmKeysListOptionalParams
options パラメーター。
戻り値
listVersions(string, string, string, ManagedHsmKeysListVersionsOptionalParams)
指定したマネージド HSM 内の指定したキーのバージョンを一覧表示します。
function listVersions(resourceGroupName: string, name: string, keyName: string, options?: ManagedHsmKeysListVersionsOptionalParams): PagedAsyncIterableIterator<ManagedHsmKey, ManagedHsmKey[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- name
-
string
指定したリソース グループ内の Managed HSM プールの名前。
- keyName
-
string
作成するキーの名前。 指定した値は、サービスを実行するためにグローバルにコピーされる場合があります。 指定する値には、個人を特定できる情報や機密情報を含めてはなりません。
options パラメーター。