HSM Security Domain - Transfer Key

Tjänst:

Key Vault

API-version:

2025-07-01

Hämta överföringsnyckel för säkerhetsdomän

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	TransferKey	Begäran har slutförts.
Other Status Codes	KeyVaultError	Ett oväntat felsvar.

Säkerhet

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Exempel

Retrieve Security Domain transfer key

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
Error
KeyVaultError	Felundantaget för nyckelvalvet.
SecurityDomainJsonWebKey	En JSON-webbnyckel (JWK) för användning i en säkerhetsdomänåtgärd.
TransferKey	Säkerhet Överföringsnyckel för domän.

Error

Objekt

Name	Typ	Description
code	string	Felkoden.
innererror	Error	Felet på nyckelvalvsservern.
message	string	Felmeddelandet.

KeyVaultError

Objekt

Felundantaget för nyckelvalvet.

Name	Typ	Description
error	Error	Felet på nyckelvalvsservern.

SecurityDomainJsonWebKey

Objekt

En JSON-webbnyckel (JWK) för användning i en säkerhetsdomänåtgärd.

Name	Typ	Description
alg	string	Algoritm som är avsedd att användas med nyckeln.
e	string	Exponent för RSA.
key_ops	string[]	Nyckelåtgärder som stöds.
kid	string	Nyckel identifierare.
kty	string	JsonWebKey-nyckeltyp (kty), enligt definitionen i https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. För Security Domain måste det här värdet vara RSA.
n	string	RSA-modul.
use	string	Parameter för användning av offentlig nyckel. Detta är valfritt och om det finns måste det vara enc.
x5c	string[]	Parameter för X509-certifikatkedja.
x5t	string	X509-certifikat SHA1 tumavtryck. Det här är valfritt.
x5t#S256	string	X509-certifikat SHA256 tumavtryck.

TransferKey

Objekt

Säkerhet Överföringsnyckel för domän.

Name	Typ	Standardvärde	Description
key_format	string	jwk	Anger formatet för överföringsnyckeln.
transfer_key	SecurityDomainJsonWebKey		Anger överföringsnyckeln i JWK-format.