Import Key - Import Key

リファレンス

Service:: Key Vault

API Version:: 7.4

外部で作成されたキーをインポートし、格納し、キーのパラメーターと属性をクライアントに返します。
キーのインポート操作は、任意のキーの種類を Azure Key Vaultにインポートするために使用できます。名前付きのキーが既に存在する場合は、Azure Key Vault によりキーの新しいバージョンが作成されます。この操作には、キー/インポートのアクセス許可が必要です。

PUT {vaultBaseUrl}/keys/{key-name}?api-version=7.4

URI パラメーター

名前 / 必須型説明

名前	/	必須	型	説明
key-name	path	True	string	インポートされたキーの名前。指定した値は、サービスを実行するためにグローバルにコピーされる場合があります。指定する値には、個人を特定できる情報や機密情報を含めてはなりません。 Regex pattern: `^[0-9a-zA-Z-]+$`
vaultBaseUrl	path	True	string	コンテナー名 (例: https://myvault.vault.azure.net)。
api-version	query	True	string	クライアント API バージョン。

key-name

path

True

string

インポートされたキーの名前。指定した値は、サービスを実行するためにグローバルにコピーされる場合があります。指定する値には、個人を特定できる情報や機密情報を含めてはなりません。

Regex pattern: ^[0-9a-zA-Z-]+$

vaultBaseUrl

path

True

string

コンテナー名 (例: https://myvault.vault.azure.net)。

api-version

query

True

string

クライアント API バージョン。

要求本文

名前	必須	型	説明
key	True	JsonWebKey	Json Web キー
Hsm		boolean	ハードウェアキー (HSM) またはソフトウェアキーとしてインポートするかどうか。
attributes		KeyAttributes	キー管理属性。
release_policy		KeyReleasePolicy	キーをエクスポートできるポリシールール。
tags		object	キーと値のペアの形式による、アプリケーション固有のメタデータ。

応答

名前	型	説明
200 OK	KeyBundle	コンテナーにインポートされたキーバンドル。
Other Status Codes	KeyVaultError	操作が失敗した理由を説明するエラー応答をKey Vaultします。

例

Import key

Sample Request

HTTP

PUT https://myvault.vault.azure.net//keys/ImportSoftKeyTest?api-version=7.4

{
  "key": {
    "kty": "RSA",
    "n": "nKAwarTrOpzd1hhH4cQNdVTgRF-b0ubPD8ZNVf0UXjb62QuAk3Dn68ESThcF7SoDYRx2QVcfoMC9WCcuQUQDieJF-lvJTSer1TwH72NBovwKlHvrXqEI0a6_uVYY5n-soGt7qFZNbwQLdWWA6PrbqTLIkv6r01dcuhTiQQAn6OWEa0JbFvWfF1kILQIaSBBBaaQ4R7hZs7-VQTHGD7J1xGteof4gw2VTiwNdcE8p5UG5b6S9KQwAeET4yB4KFPwQ3TDdzxJQ89mwYVi_sgAIggN54hTq4oEKYJHBOMtFGIN0_HQ60ZSUnpOi87xNC-8VFqnv4rfTQ7nkK6XMvjMVfw",
    "e": "AQAB",
    "d": "GeT1_D5LAZa7qlC7WZ0DKJnOth8kcPrN0urTEFtWCbmHQWkAad_px_VUpGp0BWDDzENbXbQcu4QCCdf4crve5eXt8dVI86OSah-RpEdBq8OFsETIhg2Tmq8MbYTJexoynRcIC62xAaCmkFMmu931gQSvWnYWTEuOPgmD2oE_F-bP9TFlGRc69a6MSbtcSRyFTsd5KsUr40QS4zf2W4kZCOWejyLuxk88SXgUqcJx86Ulc1Ol1KkTBLadvReAZCyCMwKBlNRGw46BU_iK0vK7rTD9fmEd639Gjti6eLpnyQYpnVe8uGgwVU1fHBkAKyapWoEG6VMhMntcrvgukKLIsQ",
    "dp": "ZGnmWx-Nca71z9a9vvT4g02iv3S-3kSgmhl8JST09YQwK8tfiK7nXnNMtXJi2K4dLKKnLicGtCzB6W3mXdLcP2SUOWDOeStoBt8HEBT4MrI1psCKqnBum78WkHju90rBFj99amkP6UeQy5EASAzgmKQu2nUaUnRV0lYP8LHMCkE",
    "dq": "dtpke0foFs04hPS6XYLA5lc7-1MAHfZKN4CkMAofwDqPmRQzCxpDJUk0gMWGJEdU_Lqfbg22Py44cci0dczH36NW3UU5BL86T2_SPPDOuyX7kDscrIJCdowxQCGJHGRBEozM_uTL46wu6UnUIv7m7cuGgodJyZBcdwpo6ziFink",
    "qi": "Y9KD5GaHkAYmAqpOfAQUMr71QuAAaBb0APzMuUvoEYw39PD3_vJeh9HZ15QmJ8zCX10-nlzUB-bWwvK-rGcJXbK4pArilr5MiaYv7e8h5eW2zs2_itDJ6Oebi-wVbMhg7DvUTBbkCvPhhIedE4UlDQmMYP7RhzVVs7SfmkGs_DQ",
    "p": "v1jeCPnuJQM2PW2690Q9KJk0Ulok8VFGjkcHUHVi3orKdy7y_TCIWM6ZGvgFzI6abinzYbTEPKV4wFdMAwvOWmawXj5YrsoeB44_HXJ0ak_5_iP6XXR8MLGXbd0ZqsxvAZyzMj9vyle7EN2cBod6aenI2QZoRDucPvjPwZsZotk",
    "q": "0Yv-Dj6qnvx_LL70lUnKA6MgHE_bUC4drl5ZNDDsUdUUYfxIK4G1rGU45kHGtp-Qg-Uyf9s52ywLylhcVE3jfbjOgEozlSwKyhqfXkLpMLWHqOKj9fcfYd4PWKPOgpzWsqjA6fJbBUMYo0CU2G9cWCtVodO7sBJVSIZunWrAlBc"
  },
  "tags": {
    "purpose": "unit test"
  }
}

Sample Response

Status code:: 200

{
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/ImportSoftKeyTest/2eb4a15d74184c6f84159c3ca90f0f4b",
    "kty": "RSA",
    "key_ops": [
      "encrypt",
      "decrypt",
      "sign",
      "verify",
      "wrapKey",
      "unwrapKey"
    ],
    "n": "nKAwarTrOpzd1hhH4cQNdVTgRF-b0ubPD8ZNVf0UXjb62QuAk3Dn68ESThcF7SoDYRx2QVcfoMC9WCcuQUQDieJF-lvJTSer1TwH72NBovwKlHvrXqEI0a6_uVYY5n-soGt7qFZNbwQLdWWA6PrbqTLIkv6r01dcuhTiQQAn6OWEa0JbFvWfF1kILQIaSBBBaaQ4R7hZs7-VQTHGD7J1xGteof4gw2VTiwNdcE8p5UG5b6S9KQwAeET4yB4KFPwQ3TDdzxJQ89mwYVi_sgAIggN54hTq4oEKYJHBOMtFGIN0_HQ60ZSUnpOi87xNC-8VFqnv4rfTQ7nkK6XMvjMVfw",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": true,
    "created": 1493942691,
    "updated": 1493942691,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "purpose": "unit test"
  }
}

定義

名前	説明
DeletionRecoveryLevel	現在のコンテナー内のキーに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合、キーは特権ユーザーによって完全に削除できます。それ以外の場合、保持間隔の最後にキーを消去できるのはシステムだけです。
Error	キーコンテナーサーバーエラー。
JsonWebKey	の時点 http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	楕円曲線名。有効な値については、「JsonWebKeyCurveName」を参照してください。
JsonWebKeyType	で定義 https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40されている JsonWebKey キー型 (kty)。
KeyAttributes	キーコンテナーサービスによって管理されるキーの属性。
KeyBundle	WebKey とその属性で構成される KeyBundle。
KeyImportParameters	キーのインポートパラメーター。
KeyReleasePolicy	キーをエクスポートできるポリシールール。
KeyVaultError	キーコンテナーエラー例外。

DeletionRecoveryLevel

現在のコンテナー内のキーに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合、キーは特権ユーザーによって完全に削除できます。それ以外の場合、保持間隔の最後にキーを消去できるのはシステムだけです。

名前	型	説明
CustomizedRecoverable	string	即時および永続的な削除 (つまり、7<= SoftDeleteRetentionInDays 90 の場合は消去) を行わずに削除を回復できるコンテナーの状態を < 示します。このレベルでは、保持期間中およびサブスクリプションが引き続き使用できる間に、削除されたエンティティの回復可能性が保証されます。
CustomizedRecoverable+ProtectedSubscription	string	7<= SoftDeleteRetentionInDays < 90 の場合、削除が回復可能で、即時および完全な削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことができないコンテナーとサブスクリプションの状態を示します。このレベルでは、保持期間中に削除されたエンティティの回復可能性が保証され、サブスクリプション自体を取り消すことができないという事実も反映されます。
CustomizedRecoverable+Purgeable	string	削除が回復可能であり、即時および永続的な削除も許可されるコンテナーの状態を示します (つまり、7< = SoftDeleteRetentionInDays < 90 の場合は消去)。このレベルでは、消去操作が要求されるか、サブスクリプションが取り消されない限り、保持期間中に削除されたエンティティの回復可能性が保証されます。
Purgeable	string	復旧の可能性がない、削除が元に戻せない操作であるコンテナーの状態を示します。このレベルは、Delete 操作に対して使用できる保護に対応しません。エンティティレベル以上 (コンテナー、リソースグループ、サブスクリプションなど) で Delete 操作を受け入れると、データが回復不能に失われます。
Recoverable	string	即時および永続的な削除 (つまり消去) を行わずに削除を回復できるコンテナーの状態を示します。このレベルでは、保持期間 (90 日) の間、およびサブスクリプションがまだ使用可能な間に、削除されたエンティティの回復可能性が保証されます。回復されていない場合、システムは90日後にそれを完全に削除します
Recoverable+ProtectedSubscription	string	保持期間内 (90 日以内)、即時削除と完全削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことができないコンテナーとサブスクリプションの状態を示します。回復されていない場合、システムは90日後にそれを完全に削除します
Recoverable+Purgeable	string	削除が回復可能であり、即時および永続的な削除 (消去) も許可されるコンテナーの状態を示します。このレベルでは、消去操作が要求されたか、サブスクリプションが取り消されない限り、保持期間中 (90 日間) に削除されたエンティティの回復可能性が保証されます。回復されていない場合、システムは90日後にそれを完全に削除します

Error

キーコンテナーサーバーエラー。

名前	型	説明
code	string	エラーコード。
innererror	Error	キーコンテナーサーバーエラー。
message	string	エラーメッセージ。

JsonWebKey

の時点 http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

名前	型	説明
crv	JsonWebKeyCurveName	楕円曲線名。有効な値については、「JsonWebKeyCurveName」を参照してください。
d	string	RSA プライベート指数、または EC 秘密キーの D コンポーネント。
dp	string	RSA 秘密キーパラメーター。
dq	string	RSA 秘密キーパラメーター。
e	string	RSA パブリック指数。
k	string	対称キー。
key_hsm	string	保護されたキー。"Bring Your Own Key" と共に使用されます。
key_ops	string[]	サポートされているキー操作。
kid	string	キー識別子。
kty	JsonWebKeyType	で定義 https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40されている JsonWebKey キー型 (kty)。
n	string	RSA 剰余。
p	string	RSA シークレットプライム。
q	string	RSA シークレット素数、p < q。
qi	string	RSA 秘密キーパラメーター。
x	string	EC 公開キーの X コンポーネント。
y	string	EC 公開キーの Y コンポーネント。

JsonWebKeyCurveName

楕円曲線名。有効な値については、「JsonWebKeyCurveName」を参照してください。

名前	型	説明
P-256	string	NIST P-256 楕円曲線、別名 SECG 曲線SECP256R1。
P-256K	string	SECG SECP256K1楕円曲線です。
P-384	string	NIST P-384 楕円曲線、別名 SECG 曲線SECP384R1。
P-521	string	NIST P-521 楕円曲線、別名 SECG 曲線SECP521R1。

JsonWebKeyType

で定義 https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40されている JsonWebKey キー型 (kty)。

名前	型	説明
EC	string	楕円曲線
EC-HSM	string	HSM に格納されている秘密キーを持つ省略記号曲線。
RSA	string	RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM	string	HSM に格納されている秘密キーを持つ RSA。
oct	string	オクテットシーケンス (対称キーを表すために使用)
oct-HSM	string	HSM に格納されるオクテットシーケンス (対称キーを表すために使用されます)。

KeyAttributes

キーコンテナーサービスによって管理されるキーの属性。

名前	型	説明
created	integer	作成時刻 (UTC)。
enabled	boolean	オブジェクトが有効かどうかを判断します。
exp	integer	有効期限 (UTC)。
exportable	boolean	秘密キーをエクスポートできるかどうかを示します。エクスポート可能なキーの最初のバージョンを作成するときは、リリースポリシーを指定する必要があります。
nbf	integer	UTC の日付より前ではありません。
recoverableDays	integer	softDelete データ保持日数。 softDelete が有効な場合は >=7、 <=90、それ以外の場合は 0 にする必要があります。
recoveryLevel	DeletionRecoveryLevel	現在のコンテナー内のキーに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合、キーは特権ユーザーによって完全に削除できます。それ以外の場合、保持間隔の最後にキーを消去できるのはシステムだけです。
updated	integer	UTC での最終更新時刻。

KeyBundle

WebKey とその属性で構成される KeyBundle。

名前	型	説明
attributes	KeyAttributes	キー管理属性。
key	JsonWebKey	Json Web キー。
managed	boolean	True キーの有効期間がキーコンテナーによって管理されている場合。これが証明書をバックアップするキーの場合、マネージドは true になります。
release_policy	KeyReleasePolicy	キーをエクスポートできるポリシールール。
tags	object	キーと値のペアの形式による、アプリケーション固有のメタデータ。

KeyImportParameters

キーのインポートパラメーター。

名前	型	説明
Hsm	boolean	ハードウェアキー (HSM) またはソフトウェアキーとしてインポートするかどうか。
attributes	KeyAttributes	キー管理属性。
key	JsonWebKey	Json Web キー
release_policy	KeyReleasePolicy	キーをエクスポートできるポリシールール。
tags	object	キーと値のペアの形式による、アプリケーション固有のメタデータ。

KeyReleasePolicy

キーをエクスポートできるポリシールール。

名前	型	既定値	説明
contentType	string	application/json; charset=utf-8	コンテンツタイプとキーリリースポリシーのバージョン
data	string		キーを解放できるポリシー規則をエンコードする BLOB。 BLOB は base64 URL エンコードされている必要があります。
immutable	boolean		ポリシーの変更可能性の状態を定義します。変更不可とマークされると、このフラグをリセットできず、どのような状況でもポリシーを変更することはできません。

KeyVaultError

キーコンテナーエラー例外。

名前	型	説明
error	Error	キーコンテナーサーバーエラー。

Import Key - Import Key

URI パラメーター

要求本文

応答

例

Import key

Sample Request

Sample Response

定義

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyType

KeyAttributes

KeyBundle

KeyImportParameters

KeyReleasePolicy

KeyVaultError

その他のリソース