HSM Security Domain - Transfer Key

Služba:

Key Vault

Verze rozhraní API:

2025-07-01

Načíst klíč pro přenos domény Security Security

GET {vaultBaseUrl}/securitydomain/upload?api-version=2025-07-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	TransferKey	Požadavek byl úspěšný.
Other Status Codes	KeyVaultError	Neočekávaná chybová odpověď

Zabezpečení

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
https://vault.azure.net/.default

Příklady

Retrieve Security Domain transfer key

Ukázkový požadavek

HTTP

GET https://myvault.vault.azure.net//securitydomain/upload?api-version=2025-07-01

Ukázková odpověď

Stavový kód:

200

{
  "key_format": "jwk",
  "transfer_key": {
    "kid": "https://myvault.vault.azure.net/transfer_key",
    "kty": "RSA",
    "key_ops": [
      "encrypt"
    ],
    "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w",
    "e": "AQAB",
    "alg": "RSA-OAEP-256",
    "x5c": [
      "MIIEnTCCBAgIBATANBgkAoWgAwIqhkiG9w0BAQsFADAQMQ4wDAYDVQQDDAVjZXJ0QTAeFw0yMDA0MjYwM/mivTQ26aDwb1Pd8h+SGcgJNy1VOnmI5+uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB/yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp/TO5+kQigYkgVZXcPjbm2c0hdkisPt+APqEdMotmYTANxtC6McP+9KOO8+12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH/36Vfc5ad+nxRYwYObRYfgOh8vpYaw3cpj5+UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv/ZX7qbNhv11a76gJRi/IoHkcf1UTpxCoD+eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz/ZCOrc+RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vsCAwEAAaMCMAAwDQYJKoZIhvcNAQELBQADggIBAAjHy9GCPejDYIVb/iv8Wo40n317LQN7H6ay+YB5L2byEQATvC1ixde6VqwU6k9VdoQOTfP3xJhfstKrO+n5mFJBL4KG8BZBbd6XQu/ggPLKEIVZFbeQkX6o03K54gY8GxYjHr6gF12I6heLWVKA/Qi480GqSlp2Nz+LE1jgPp9u52xpUPjsvRHXtxYZ7Q3O2jhPToNr3D/TZSu3tmQOeqj9M/igLDe9TxqN9C9jraUGR7Lr4zN1srtvIKhxGMS3Q9kC4Mq+ZNNIwC9+jzzd8fB2pGJP/iTFDzB0pDh9Jz0/CR4O4aGoYqkQEx629aZH2TzhOh2yf04TaniwkHXnUEsPTxrpY8ty/OUG3HzBMHCDhS08ZSimrrxhiWyH6g0OEglXVGrI2nH6nnQIn1MTNILcjUTMRt/WSOz6G07oZciAouKD2YS/W1qPap600kGhTya81BuYThGmFoXVMs7Mk3XBzZ81b6hJ6ncwCLb3g4YzqeQ8bOf42jYJctq4tPNaXTfoC7N0FX7lPVJpRdh6BFcHYcg0NPWJsdk6LtSJB6bp2qptRAgJ5S94s843FRd8PRFE10TKDfj3YFRBNkx7qDjwUhtN8/JC9+RHHw0Ngd0x2/BLqeCEMAQaJoC53h0aMLW6PSyovnsLvdJbN/rYc15qUXSz8TtjaHFpjsy/Fo5H"
    ],
    "x5t": "dJKBile6IJDrRGqa3k5d8_IKFdI",
    "x5t#S256": "gIBQCTDDN"
  }
}

Definice

Name	Description
Error
KeyVaultError	Výjimka chyby trezoru klíčů.
SecurityDomainJsonWebKey	Webový klíč JSON (JWK) pro použití v operaci domény zabezpečení.
TransferKey	Zabezpečení Klíč pro přenos domény.

Error

Objekt

Name	Typ	Description
code	string	Kód chyby.
innererror	Error	Chyba serveru trezoru klíčů.
message	string	Chybová zpráva.

KeyVaultError

Objekt

Výjimka chyby trezoru klíčů.

Name	Typ	Description
error	Error	Chyba serveru trezoru klíčů.

SecurityDomainJsonWebKey

Objekt

Webový klíč JSON (JWK) pro použití v operaci domény zabezpečení.

Name	Typ	Description
alg	string	Algoritmus určený pro použití s klíčem.
e	string	Veřejný zástupce RSA.
key_ops	string[]	Podporované klíčové operace.
kid	string	Identifikátor klíče.
kty	string	JsonWebKey Typ klíče (kty), jak je definováno v https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Pro doménu zabezpečení musí být tato hodnota RSA.
n	string	Modul RSA.
use	string	Parametr použití veřejného klíče. To je volitelné a pokud je k dispozici, musí být enc.
x5c	string[]	Parametr řetězu certifikátů X509.
x5t	string	Kryptografický otisk SHA1 certifikátu X509. Toto je volitelné.
x5t#S256	string	Certifikát X509 SHA256 Otisk prstu.

TransferKey

Objekt

Zabezpečení Klíč pro přenos domény.

Name	Typ	Default value	Description
key_format	string	jwk	Určuje formát přenosového klíče.
transfer_key	SecurityDomainJsonWebKey		Určuje přenosový klíč ve formátu JWK.