Import Key - Import Key

참조

Service:: Key Vault

API Version:: 7.4

외부에서 만든 키를 가져와 저장한 다음 키 매개 변수와 특성을 클라이언트로 반환합니다.
키 가져오기 작업은 모든 키 형식을 Azure Key Vault 가져오는 데 사용할 수 있습니다. 명명된 키가 이미 있으면 Azure 키 자격 증명 모음에서 키의 새 버전을 만듭니다. 이 작업을 수행하려면 키/가져오기 권한이 필요합니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description

Name	In(다음 안에)	필수	형식	Description
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 버전입니다.

요청 본문

Name	필수	형식	Description
key	True	JsonWebKey	Json 웹 키
Hsm		boolean	HSM(하드웨어 키) 또는 소프트웨어 키로 가져올지 여부입니다.
attributes		KeyAttributes	키 관리 특성입니다.
release_policy		KeyReleasePolicy	키를 내보낼 수 있는 정책 규칙입니다.
tags		object	키/값 쌍 형식의 애플리케이션 특정 메타데이터입니다.

응답

Name	형식	Description
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"
  }
}

정의

Name	Description
DeletionRecoveryLevel	현재 자격 증명 모음의 키에 대해 현재 적용되는 삭제 복구 수준을 반영합니다. 'Purgeable'이 포함된 경우 권한 있는 사용자가 키를 영구적으로 삭제할 수 있습니다. 그렇지 않으면 시스템에서만 보존 간격이 끝날 때 키를 제거할 수 있습니다.
Error	키 자격 증명 모음 서버 오류입니다.
JsonWebKey	현재 http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	타원 곡선 이름입니다. 유효한 값은 JsonWebKeyCurveName을 참조하세요.
JsonWebKeyType	에 정의된 JsonWebKey 키 형식(kty)입니다 https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes	키 자격 증명 모음 서비스에서 관리하는 키의 특성입니다.
KeyBundle	WebKey와 해당 특성으로 구성된 KeyBundle입니다.
KeyImportParameters	키 가져오기 매개 변수입니다.
KeyReleasePolicy	키를 내보낼 수 있는 정책 규칙입니다.
KeyVaultError	키 자격 증명 모음 오류 예외입니다.

DeletionRecoveryLevel

현재 자격 증명 모음의 키에 대해 현재 적용되는 삭제 복구 수준을 반영합니다. 'Purgeable'이 포함된 경우 권한 있는 사용자가 키를 영구적으로 삭제할 수 있습니다. 그렇지 않으면 시스템에서만 보존 간격이 끝날 때 키를 제거할 수 있습니다.

Name	형식	Description
CustomizedRecoverable	string	즉시 영구 삭제할 가능성 없이 삭제를 복구할 수 있는 자격 증명 모음 상태를 나타냅니다(즉, 7<= SoftDeleteRetentionInDays < 90인 경우 제거). 이 수준은 보존 간격 동안 및 구독을 계속 사용할 수 있는 동안 삭제된 엔터티의 복구 가능성을 보장합니다.
CustomizedRecoverable+ProtectedSubscription	string	삭제가 복구 가능하고, 즉각적이고 영구적인 삭제(즉, 제거)가 허용되지 않으며, 7<= SoftDeleteRetentionInDays < 90일 때 구독 자체를 영구적으로 취소할 수 없는 자격 증명 모음 및 구독 상태를 나타냅니다. 이 수준은 보존 간격 동안 삭제된 엔터티의 복구 가능성을 보장하며 구독 자체를 취소할 수 없다는 사실도 반영합니다.
CustomizedRecoverable+Purgeable	string	삭제를 복구할 수 있는 자격 증명 모음 상태와 즉시 영구 삭제를 허용하는 자격 증명 모음 상태를 나타냅니다(즉, 7<= SoftDeleteRetentionInDays < 90인 경우 제거). 이 수준은 제거 작업이 요청되거나 구독이 취소되지 않는 한 보존 간격 동안 삭제된 엔터티의 복구 가능성을 보장합니다.
Purgeable	string	삭제가 복구되지 않고 되돌릴 수 없는 작업인 자격 증명 모음 상태를 표시합니다. 이 수준은 삭제 작업에 대해 사용할 수 있는 보호가 없음에 해당합니다. 엔터티 수준 이상(자격 증명 모음, 리소스 그룹, 구독 등)에서 삭제 작업을 수락하면 데이터가 돌이킬 수 없을 정도로 손실됩니다.
Recoverable	string	즉시 영구 삭제(즉, 제거)할 가능성 없이 삭제를 복구할 수 있는 자격 증명 모음 상태를 나타냅니다. 이 수준은 보존 간격(90일)과 구독을 계속 사용할 수 있는 동안 삭제된 엔터티의 복구 가능성을 보장합니다. 시스템이 복구되지 않은 경우 90일 후에 영구적으로 삭제합니다.
Recoverable+ProtectedSubscription	string	보존 간격(90일) 내에 삭제를 복구할 수 있고, 즉시 및 영구 삭제(즉, 제거)가 허용되지 않으며 구독 자체를 영구적으로 취소할 수 없는 자격 증명 모음 및 구독 상태를 나타냅니다. 시스템이 복구되지 않은 경우 90일 후에 영구적으로 삭제합니다.
Recoverable+Purgeable	string	삭제를 복구할 수 있고 즉시 영구 삭제(즉, 제거)도 허용하는 자격 증명 모음 상태를 나타냅니다. 이 수준은 제거 작업이 요청되거나 구독이 취소되지 않는 한 보존 간격(90일) 동안 삭제된 엔터티의 복구 가능성을 보장합니다. 시스템이 복구되지 않은 경우 90일 후에 영구적으로 삭제합니다.

Error

키 자격 증명 모음 서버 오류입니다.

Name	형식	Description
code	string	오류 코드입니다.
innererror	Error	키 자격 증명 모음 서버 오류입니다.
message	string	오류 메시지입니다.

JsonWebKey

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

Name	형식	Description
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	에 정의된 JsonWebKey 키 형식(kty)입니다 https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n	string	RSA 모듈러스.
p	string	RSA 비밀 프라임.
q	string	RSA 비밀 프라임, p < q.
qi	string	RSA 프라이빗 키 매개 변수입니다.
x	string	EC 공개 키의 X 구성 요소입니다.
y	string	EC 공개 키의 Y 구성 요소입니다.

JsonWebKeyCurveName

타원 곡선 이름입니다. 유효한 값은 JsonWebKeyCurveName을 참조하세요.

Name	형식	Description
P-256	string	NIST P-256 타원 곡선, AKA SECG 곡선 SECP256R1.
P-256K	string	SECG SECP256K1 타원 곡선입니다.
P-384	string	NIST P-384 타원 곡선, AKA SECG 곡선 SECP384R1.
P-521	string	NIST P-521 타원 곡선, AKA SECG 곡선 SECP521R1.

JsonWebKeyType

에 정의된 JsonWebKey 키 형식(kty)입니다 https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Name	형식	Description
EC	string	타원 곡선.
EC-HSM	string	HSM에 저장된 프라이빗 키가 있는 타원 곡선입니다.
RSA	string	RSA(https://tools.ietf.org/html/rfc3447)
RSA-HSM	string	HSM에 저장된 프라이빗 키가 있는 RSA입니다.
oct	string	Octet 시퀀스(대칭 키를 나타내는 데 사용됨)
oct-HSM	string	HSM에 저장되는 Octet 시퀀스(대칭 키를 나타내는 데 사용됨)

KeyAttributes

키 자격 증명 모음 서비스에서 관리하는 키의 특성입니다.

Name	형식	Description
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입니다.

Name	형식	Description
attributes	KeyAttributes	키 관리 특성입니다.
key	JsonWebKey	Json 웹 키입니다.
managed	boolean	키의 수명이 키 자격 증명 모음에서 관리되는 경우 True입니다. 인증서를 지원하는 키인 경우 관리되는 것이 true입니다.
release_policy	KeyReleasePolicy	키를 내보낼 수 있는 정책 규칙입니다.
tags	object	키/값 쌍 형식의 애플리케이션 특정 메타데이터입니다.

KeyImportParameters

키 가져오기 매개 변수입니다.

Name	형식	Description
Hsm	boolean	HSM(하드웨어 키) 또는 소프트웨어 키로 가져올지 여부입니다.
attributes	KeyAttributes	키 관리 특성입니다.
key	JsonWebKey	Json 웹 키
release_policy	KeyReleasePolicy	키를 내보낼 수 있는 정책 규칙입니다.
tags	object	키/값 쌍 형식의 애플리케이션 특정 메타데이터입니다.

KeyReleasePolicy

키를 내보낼 수 있는 정책 규칙입니다.

Name	형식	기본값	Description
contentType	string	application/json; charset=utf-8	콘텐츠 형식 및 키 릴리스 정책 버전
data	string		키를 해제할 수 있는 정책 규칙을 인코딩하는 Blob입니다. Blob은 base64 URL 인코딩되어야 합니다.
immutable	boolean		정책의 변경 가능성 상태를 정의합니다. 변경할 수 없는 것으로 표시되면 이 플래그를 다시 설정할 수 없으며 어떤 상황에서도 정책을 변경할 수 없습니다.

KeyVaultError

키 자격 증명 모음 오류 예외입니다.

Name	형식	Description
error	Error	키 자격 증명 모음 서버 오류입니다.

다음을 통해 공유

Import Key - Import Key

URI 매개 변수

요청 본문

응답

예제

Import key

Sample Request

Sample Response

정의

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyType

KeyAttributes

KeyBundle

KeyImportParameters

KeyReleasePolicy

KeyVaultError

추가 리소스