Import Key - Import Key

  • Referensi
Service:
Key Vault
API Version:
7.3

Mengimpor kunci yang dibuat secara eksternal, menyimpannya, dan mengembalikan parameter dan atribut utama ke klien.
Operasi kunci impor dapat digunakan untuk mengimpor jenis kunci apa pun ke azure Key Vault. Jika kunci bernama sudah ada, Azure Key Vault membuat versi kunci baru. Operasi ini memerlukan izin kunci/impor.

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

Parameter URI

Name In Required Type Description
key-name
 path True
  • string

Nama untuk kunci yang diimpor.

Regex pattern: ^[0-9a-zA-Z-]+$
vaultBaseUrl
 path True
  • string

Nama vault, misalnya https://myvault.vault.azure.net.
api-version
 query True
  • string

Versi API klien.

Isi Permintaan

Name Required Type Description
key True

Kunci web Json
Hsm
  • boolean

Apakah akan mengimpor sebagai kunci perangkat keras (HSM) atau kunci perangkat lunak.
attributes

Atribut manajemen kunci.
release_policy

Aturan kebijakan tempat kunci dapat diekspor.
tags
  • object

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

Respons

Name Type Description
200 OK

Bundel kunci yang diimpor ke vault.
Other Status Codes

Key Vault respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

Import key

Sample Request

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

{
  "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"
  }
}

Definisi

DeletionRecoveryLevel

Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk kunci di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh' kunci dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh kunci, di akhir interval retensi.
Error

Kesalahan server brankas kunci.
JsonWebKey

Pada http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName

Nama kurva elips. Untuk nilai yang valid, lihat JsonWebKeyCurveName.
JsonWebKeyType

Jenis Kunci JsonWebKey (kty), seperti yang didefinisikan dalam https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes

Atribut kunci yang dikelola oleh layanan brankas kunci.
KeyBundle

KeyBundle yang terdiri dari WebKey ditambah atributnya.
KeyImportParameters

Parameter impor utama.
KeyReleasePolicy

Aturan kebijakan tempat kunci dapat diekspor.
KeyVaultError

Pengecualian kesalahan brankas kunci.

DeletionRecoveryLevel

Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk kunci di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh' kunci dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh kunci, di akhir interval retensi.

Name Type Description
CustomizedRecoverable
  • string

Menunjukkan status vault di mana penghapusan dapat dipulihkan tanpa kemungkinan untuk penghapusan segera dan permanen (yaitu hapus menyeluruh ketika 7<= SoftDeleteRetentionInDays < 90). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi dan saat langganan masih tersedia.
CustomizedRecoverable+ProtectedSubscription
  • string

Menunjukkan status vault dan langganan di mana penghapusan dapat dipulihkan, penghapusan langsung, dan permanen (yaitu pembersihan) tidak diizinkan, dan di mana langganan itu sendiri tidak dapat dibatalkan secara permanen ketika 7<= SoftDeleteRetentionInDays < 90. Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi, dan juga mencerminkan fakta bahwa langganan itu sendiri tidak dapat dibatalkan.
CustomizedRecoverable+Purgeable
  • string

Menunjukkan status vault di mana penghapusan dapat dipulihkan, dan yang juga mengizinkan penghapusan segera dan permanen (yaitu pembersihan saat 7<= SoftDeleteRetentionInDays < 90). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi, kecuali operasi Pembersihan diminta, atau langganan dibatalkan.
Purgeable
  • string

Menunjukkan status vault di mana penghapusan adalah operasi yang tidak dapat diubah, tanpa kemungkinan untuk pemulihan. Tingkat ini sesuai dengan tidak ada perlindungan yang tersedia terhadap operasi Hapus; data hilang secara tidak dapat diambil setelah menerima operasi Hapus di tingkat entitas atau yang lebih tinggi (vault, grup sumber daya, langganan, dll.)
Recoverable
  • string

Menunjukkan status vault di mana penghapusan dapat dipulihkan tanpa kemungkinan untuk penghapusan segera dan permanen (yaitu penghapusan menyeluruh). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi (90 hari) dan saat langganan masih tersedia. Sistem akan menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan
Recoverable+ProtectedSubscription
  • string

Menunjukkan status vault dan langganan di mana penghapusan dapat dipulihkan dalam interval retensi (90 hari), penghapusan segera dan permanen (yaitu penghapusan menyeluruh) tidak diizinkan, dan di mana langganan itu sendiri tidak dapat dibatalkan secara permanen. Sistem akan menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan
Recoverable+Purgeable
  • string

Menunjukkan status vault di mana penghapusan dapat dipulihkan, dan yang juga mengizinkan penghapusan segera dan permanen (yaitu pembersihan). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi (90 hari), kecuali operasi Pembersihan diminta, atau langganan dibatalkan. Sistem akan menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan

Error

Kesalahan server brankas kunci.

Name Type Description
code
  • string

Kode kesalahan.
innererror

Kesalahan server brankas kunci.
message
  • string

Pesan kesalahan.

JsonWebKey

Pada http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Name Type Description
crv

Nama kurva elips. Untuk nilai yang valid, lihat JsonWebKeyCurveName.
d
  • string

Eksponen privat RSA, atau komponen D dari kunci privat EC.
dp
  • string

Parameter kunci privat RSA.
dq
  • string

Parameter kunci privat RSA.
e
  • string

Eksponen publik RSA.
k
  • string

Kunci simetris.
key_hsm
  • string

Kunci yang Dilindungi, digunakan dengan 'Bring Your Own Key'.
key_ops
  • string[]

Operasi kunci yang didukung.
kid
  • string

Pengidentifikasi kunci.
kty

Jenis Kunci JsonWebKey (kty), seperti yang didefinisikan dalam https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n
  • string

Modul RSA.
p
  • string

Rahasia RSA prima.
q
  • string

Prime rahasia RSA, dengan p < q.
qi
  • string

Parameter kunci privat RSA.
x
  • string

Komponen X dari kunci umum EC.
y
  • string

Komponen Y dari kunci umum EC.

JsonWebKeyCurveName

Nama kurva elips. Untuk nilai yang valid, lihat JsonWebKeyCurveName.

Name Type Description
P-256
  • string

Kurva elips NIST P-256, kurva AKA SECG SECP256R1.
P-256K
  • string

Kurva elips SECG SECP256K1.
P-384
  • string

Kurva elips NIST P-384, kurva AKA SECG SECP384R1.
P-521
  • string

Kurva elips NIST P-521, kurva AKA SECG SECP521R1.

JsonWebKeyType

Jenis Kunci JsonWebKey (kty), seperti yang didefinisikan dalam https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Name Type Description
EC
  • string

Kurva Elips.
EC-HSM
  • string

Kurva Elips dengan kunci privat yang disimpan di HSM.
RSA
  • string

RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM
  • string

RSA dengan kunci privat yang disimpan di HSM.
oct
  • string

Urutan oktet (digunakan untuk mewakili kunci konten)
oct-HSM
  • string

Urutan oktet (digunakan untuk mewakili kunci konten) yang disimpan HSM.

KeyAttributes

Atribut kunci yang dikelola oleh layanan brankas kunci.

Name Type Description
created
  • integer

Waktu pembuatan di UTC.
enabled
  • boolean

Menentukan apakah objek diaktifkan.
exp
  • integer

Tanggal kedaluwarsa dalam UTC.
exportable
  • boolean

Menunjukkan apakah kunci privat dapat diekspor.
nbf
  • integer

Tidak sebelum tanggal dalam UTC.
recoverableDays
  • integer

softDelete hari retensi data. Nilai harus >=7 dan <=90 saat softDelete diaktifkan, jika tidak, 0.
recoveryLevel

Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk kunci di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh' kunci dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh kunci, di akhir interval retensi.
updated
  • integer

Waktu terakhir diperbarui di UTC.

KeyBundle

KeyBundle yang terdiri dari WebKey ditambah atributnya.

Name Type Description
attributes

Atribut manajemen kunci.
key

Kunci web Json.
managed
  • boolean

True jika masa pakai kunci dikelola oleh brankas kunci. Jika ini adalah kunci yang mendukung sertifikat, maka terkelola akan benar.
release_policy

Aturan kebijakan tempat kunci dapat diekspor.
tags
  • object

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

KeyImportParameters

Parameter impor utama.

Name Type Description
Hsm
  • boolean

Apakah akan mengimpor sebagai kunci perangkat keras (HSM) atau kunci perangkat lunak.
attributes

Atribut manajemen kunci.
key

Kunci web Json
release_policy

Aturan kebijakan tempat kunci dapat diekspor.
tags
  • object

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

KeyReleasePolicy

Aturan kebijakan tempat kunci dapat diekspor.

Name Type Default Value Description
contentType
  • string
application/json; charset=utf-8

Jenis konten dan versi kebijakan rilis kunci
data
  • string

Pengodean blob aturan kebijakan tempat kunci dapat dirilis.
immutable
  • boolean

Menentukan status mutabilitas kebijakan. Setelah ditandai tidak dapat diubah, bendera ini tidak dapat diatur ulang dan kebijakan tidak dapat diubah dalam keadaan apa pun.

KeyVaultError

Pengecualian kesalahan brankas kunci.

Name Type Description
error

Kesalahan server brankas kunci.