Vaults - Get
Lekéri a megadott Azure Key Vaultot.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}?api-version=2022-07-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Annak az erőforráscsoportnak a neve, amelyhez a tároló tartozik. |
subscription
|
path | True |
string |
Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz. |
vault
|
path | True |
string |
A tároló neve. |
api-version
|
query | True |
string |
Ügyfél API-verziója. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Lekért tároló |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Példák
Retrieve a vault
Sample Request
Sample Response
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault",
"name": "sample-vault",
"type": "Microsoft.KeyVault/vaults",
"location": "westus",
"tags": {},
"systemData": {
"createdBy": "keyVaultUser1",
"createdByType": "User",
"createdAt": "2020-01-01T12:00:00.0000000Z",
"lastModifiedBy": "keyVaultUser2",
"lastModifiedByType": "User",
"lastModifiedAt": "2020-01-01T12:00:00.0000000Z"
},
"properties": {
"sku": {
"family": "A",
"name": "standard"
},
"tenantId": "00000000-0000-0000-0000-000000000000",
"accessPolicies": [
{
"tenantId": "00000000-0000-0000-0000-000000000000",
"objectId": "00000000-0000-0000-0000-000000000000",
"permissions": {
"keys": [
"encrypt",
"decrypt",
"wrapKey",
"unwrapKey",
"sign",
"verify",
"get",
"list",
"create",
"update",
"import",
"delete",
"backup",
"restore",
"recover",
"purge"
],
"secrets": [
"get",
"list",
"set",
"delete",
"backup",
"restore",
"recover",
"purge"
],
"certificates": [
"get",
"list",
"delete",
"create",
"import",
"update",
"managecontacts",
"getissuers",
"listissuers",
"setissuers",
"deleteissuers",
"manageissuers",
"recover",
"purge"
]
}
}
],
"enabledForDeployment": true,
"enabledForDiskEncryption": true,
"enabledForTemplateDeployment": true,
"hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
"vaultUri": "https://sample-vault.vault.azure.net",
"provisioningState": "Succeeded",
"publicNetworkAccess": "Enabled"
}
}
Definíciók
Name | Description |
---|---|
Access |
Egy identitás, amely hozzáfér a kulcstartóhoz. A tömb összes identitásának ugyanazt a bérlőazonosítót kell használnia, mint a kulcstartó bérlőazonosítóját. |
Actions |
Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére. |
Certificate |
Tanúsítványokra vonatkozó engedélyek |
Cloud |
Hibaválasz Key Vault erőforrás-szolgáltatótól |
Cloud |
Hibaválasz Key Vault erőforrás-szolgáltatótól |
Create |
A tároló létrehozási módja jelzi, hogy a tárolót helyre kell-e állítani. |
identity |
A Key Vault-erőforrást létrehozó identitás típusa. |
IPRule |
Egy adott IP-címről vagy IP-címtartományból származó tároló akadálymentességét szabályozó szabály. |
Key |
Kulcsokhoz való engedélyek |
Network |
Az alapértelmezett művelet, ha az ipRules és a virtualNetworkRules szabálya nem egyezik. Ezt csak a bypass tulajdonság kiértékelése után használja a rendszer. |
Network |
Azt jelzi, hogy milyen forgalom kerülheti meg a hálózati szabályokat. Ez lehet "AzureServices" vagy "None". Ha nincs megadva, az alapértelmezett érték az "AzureServices". |
Network |
A tároló hálózati elérhetőségére vonatkozó szabályok halmaza. |
Permissions |
Az identitás kulcsokhoz, titkos kulcsokhoz, tanúsítványokhoz és tárterülethez tartozó engedélyekkel rendelkezik. |
Private |
Privát végpontobjektum tulajdonságai. |
Private |
Privát végpont kapcsolateleme. |
Private |
Az aktuális kiépítési állapot. |
Private |
A privát végpont kapcsolati állapota. |
Private |
Egy objektum, amely a privát kapcsolati kapcsolat jóváhagyási állapotát jelöli. |
Secret |
Titkos kódokra vonatkozó engedélyek |
Sku |
Termékváltozat részletei |
Sku |
Termékváltozat családneve |
Sku |
Termékváltozat neve annak megadásához, hogy a kulcstartó standard vagy prémium szintű tároló-e. |
Storage |
Tárfiókokhoz való engedélyek |
System |
A Key Vault-erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok. |
Vault |
Erőforrás-információk bővített részletekkel. |
Vault |
A tároló tulajdonságai |
Vault |
A tároló kiépítési állapota. |
Virtual |
Egy adott virtuális hálózatból származó tároló akadálymentességét szabályozó szabály. |
AccessPolicyEntry
Egy identitás, amely hozzáfér a kulcstartóhoz. A tömb összes identitásának ugyanazt a bérlőazonosítót kell használnia, mint a kulcstartó bérlőazonosítóját.
Name | Típus | Description |
---|---|---|
applicationId |
string |
Annak az ügyfélnek az alkalmazásazonosítója, amely a kérelmet egy résztvevő nevében küldi el |
objectId |
string |
Egy felhasználó, szolgáltatásnév vagy biztonsági csoport objektumazonosítója a tároló Azure Active Directory-bérlőjében. Az objektumazonosítónak egyedinek kell lennie a hozzáférési szabályzatok listájához. |
permissions |
Az identitás kulcsokra, titkos kulcsokra és tanúsítványokra vonatkozó engedélyekkel rendelkezik. |
|
tenantId |
string |
Az Azure Active Directory-bérlőazonosító, amelyet a key vaultba irányuló kérések hitelesítéséhez kell használni. |
ActionsRequired
Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.
Name | Típus | Description |
---|---|---|
None |
string |
CertificatePermissions
Tanúsítványokra vonatkozó engedélyek
Name | Típus | Description |
---|---|---|
all |
string |
|
backup |
string |
|
create |
string |
|
delete |
string |
|
deleteissuers |
string |
|
get |
string |
|
getissuers |
string |
|
import |
string |
|
list |
string |
|
listissuers |
string |
|
managecontacts |
string |
|
manageissuers |
string |
|
purge |
string |
|
recover |
string |
|
restore |
string |
|
setissuers |
string |
|
update |
string |
CloudError
Hibaválasz Key Vault erőforrás-szolgáltatótól
Name | Típus | Description |
---|---|---|
error |
Hibaválasz Key Vault erőforrás-szolgáltatótól |
CloudErrorBody
Hibaválasz Key Vault erőforrás-szolgáltatótól
Name | Típus | Description |
---|---|---|
code |
string |
Hibakód. Ez egy mnemonikus, amely programozott módon fogyasztható. |
message |
string |
Felhasználóbarát hibaüzenet. Az üzenet általában honosított, és a szolgáltatás verziójától függően változhat. |
CreateMode
A tároló létrehozási módja jelzi, hogy a tárolót helyre kell-e állítani.
Name | Típus | Description |
---|---|---|
default |
string |
|
recover |
string |
identityType
A Key Vault-erőforrást létrehozó identitás típusa.
Name | Típus | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
IPRule
Egy adott IP-címről vagy IP-címtartományból származó tároló akadálymentességét szabályozó szabály.
Name | Típus | Description |
---|---|---|
value |
string |
Egy IPv4-címtartomány CIDR-jelölésben, például "124.56.78.91" (egyszerű IP-cím) vagy "124.56.78.0/24" (minden cím, amely a 124.56.78-as számmal kezdődik). |
KeyPermissions
Kulcsokhoz való engedélyek
Name | Típus | Description |
---|---|---|
all |
string |
|
backup |
string |
|
create |
string |
|
decrypt |
string |
|
delete |
string |
|
encrypt |
string |
|
get |
string |
|
getrotationpolicy |
string |
|
import |
string |
|
list |
string |
|
purge |
string |
|
recover |
string |
|
release |
string |
|
restore |
string |
|
rotate |
string |
|
setrotationpolicy |
string |
|
sign |
string |
|
unwrapKey |
string |
|
update |
string |
|
verify |
string |
|
wrapKey |
string |
NetworkRuleAction
Az alapértelmezett művelet, ha az ipRules és a virtualNetworkRules szabálya nem egyezik. Ezt csak a bypass tulajdonság kiértékelése után használja a rendszer.
Name | Típus | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
NetworkRuleBypassOptions
Azt jelzi, hogy milyen forgalom kerülheti meg a hálózati szabályokat. Ez lehet "AzureServices" vagy "None". Ha nincs megadva, az alapértelmezett érték az "AzureServices".
Name | Típus | Description |
---|---|---|
AzureServices |
string |
|
None |
string |
NetworkRuleSet
A tároló hálózati elérhetőségére vonatkozó szabályok halmaza.
Name | Típus | Description |
---|---|---|
bypass |
Azt jelzi, hogy milyen forgalom kerülheti meg a hálózati szabályokat. Ez lehet "AzureServices" vagy "None". Ha nincs megadva, az alapértelmezett érték az "AzureServices". |
|
defaultAction |
Az alapértelmezett művelet, ha az ipRules és a virtualNetworkRules szabálya nem egyezik. Ezt csak a bypass tulajdonság kiértékelése után használja a rendszer. |
|
ipRules |
IPRule[] |
Az IP-címszabályok listája. |
virtualNetworkRules |
A virtuális hálózati szabályok listája. |
Permissions
Az identitás kulcsokhoz, titkos kulcsokhoz, tanúsítványokhoz és tárterülethez tartozó engedélyekkel rendelkezik.
Name | Típus | Description |
---|---|---|
certificates |
Tanúsítványokra vonatkozó engedélyek |
|
keys |
Kulcsok engedélyei |
|
secrets |
Titkos kódokra vonatkozó engedélyek |
|
storage |
Tárfiókok engedélyei |
PrivateEndpoint
Privát végpontobjektum tulajdonságai.
Name | Típus | Description |
---|---|---|
id |
string |
A privát végpont erőforrásának teljes azonosítója. |
PrivateEndpointConnectionItem
Privát végpont kapcsolateleme.
Name | Típus | Description |
---|---|---|
etag |
string |
A privát végponti kapcsolat állapotának változásakor módosul. |
id |
string |
A privát végponti kapcsolat azonosítója. |
properties.privateEndpoint |
A privát végpont objektumának tulajdonságai. |
|
properties.privateLinkServiceConnectionState |
A privát kapcsolat jóváhagyási állapota. |
|
properties.provisioningState |
A privát végponti kapcsolat kiépítési állapota. |
PrivateEndpointConnectionProvisioningState
Az aktuális kiépítési állapot.
Name | Típus | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Disconnected |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
PrivateEndpointServiceConnectionStatus
A privát végpont kapcsolati állapota.
Name | Típus | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
Egy objektum, amely a privát kapcsolati kapcsolat jóváhagyási állapotát jelöli.
Name | Típus | Description |
---|---|---|
actionsRequired |
Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére. |
|
description |
string |
A jóváhagyás vagy elutasítás oka. |
status |
Azt jelzi, hogy a kulcstartó tulajdonosa jóváhagyta-e, elutasította vagy eltávolította-e a kapcsolatot. |
SecretPermissions
Titkos kódokra vonatkozó engedélyek
Name | Típus | Description |
---|---|---|
all |
string |
|
backup |
string |
|
delete |
string |
|
get |
string |
|
list |
string |
|
purge |
string |
|
recover |
string |
|
restore |
string |
|
set |
string |
Sku
Termékváltozat részletei
Name | Típus | Description |
---|---|---|
family |
Termékváltozat családneve |
|
name |
Termékváltozat neve annak megadásához, hogy a kulcstartó standard vagy prémium szintű tároló-e. |
SkuFamily
Termékváltozat családneve
Name | Típus | Description |
---|---|---|
A |
string |
SkuName
Termékváltozat neve annak megadásához, hogy a kulcstartó standard vagy prémium szintű tároló-e.
Name | Típus | Description |
---|---|---|
premium |
string |
|
standard |
string |
StoragePermissions
Tárfiókokhoz való engedélyek
Name | Típus | Description |
---|---|---|
all |
string |
|
backup |
string |
|
delete |
string |
|
deletesas |
string |
|
get |
string |
|
getsas |
string |
|
list |
string |
|
listsas |
string |
|
purge |
string |
|
recover |
string |
|
regeneratekey |
string |
|
restore |
string |
|
set |
string |
|
setsas |
string |
|
update |
string |
SystemData
A Key Vault-erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
Name | Típus | Description |
---|---|---|
createdAt |
string |
A Key Vault-erőforrás létrehozásának időbélyege (UTC). |
createdBy |
string |
A Key Vault-erőforrást létrehozó identitás. |
createdByType |
A Key Vault-erőforrást létrehozó identitás típusa. |
|
lastModifiedAt |
string |
A Key Vault-erőforrás utolsó módosításának időbélyege (UTC). |
lastModifiedBy |
string |
Az identitás, amely legutóbb módosította a Key Vault-erőforrást. |
lastModifiedByType |
Az identitás típusa, amely legutóbb módosította a Key Vault-erőforrást. |
Vault
Erőforrás-információk bővített részletekkel.
Name | Típus | Description |
---|---|---|
id |
string |
A Key Vault-erőforrás teljes azonosítója. |
location |
string |
A Key Vault-erőforrás Azure-beli helye. |
name |
string |
A Key Vault-erőforrás neve. |
properties |
A tároló tulajdonságai |
|
systemData |
A kulcstartó rendszer metaadatai. |
|
tags |
object |
A Key Vault-erőforráshoz rendelt címkék. |
type |
string |
A Key Vault-erőforrás erőforrástípusa. |
VaultProperties
A tároló tulajdonságai
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
accessPolicies |
A kulcstartóhoz hozzáféréssel rendelkező 0–1024 identitásból álló tömb. A tömb összes identitásának ugyanazt a bérlőazonosítót kell használnia, mint a kulcstartó bérlőazonosítóját. Ha |
||
createMode |
A tároló létrehozási módja jelzi, hogy a tárolót helyre kell-e állítani. |
||
enablePurgeProtection |
boolean |
Tulajdonság, amely azt határozza meg, hogy engedélyezve van-e a végleges törlés elleni védelem ehhez a tárolóhoz. A tulajdonság true (igaz) értékre állítása aktiválja a tároló és a tartalma végleges törlése elleni védelmet – csak a Key Vault szolgáltatás kezdeményezhet helyreállíthatatlan törlést. A beállítás csak akkor érvényes, ha a helyreállítható törlés is engedélyezve van. Ennek a funkciónak a engedélyezése visszafordíthatatlan, azaz a tulajdonság nem fogadja el a false értéket. |
|
enableRbacAuthorization |
boolean |
False |
Az adatműveletek engedélyezését szabályozó tulajdonság. Ha igaz, a kulcstartó szerepköralapú Access Control (RBAC) használatával hitelesíteni fogja az adatműveleteket, és a tárolótulajdonságokban megadott hozzáférési szabályzatok figyelmen kívül lesznek hagyva. Ha hamis, a kulcstartó a tároló tulajdonságaiban megadott hozzáférési szabályzatokat fogja használni, és az Azure Resource Manager tárolt szabályzatok figyelmen kívül lesznek hagyva. Ha null vagy nincs megadva, a tároló az alapértelmezett false értékkel jön létre. Vegye figyelembe, hogy a felügyeleti műveletek mindig engedélyezve vannak az RBAC-vel. |
enableSoftDelete |
boolean |
True |
Tulajdonság annak megadásához, hogy a "helyreállítható törlés" funkció engedélyezve van-e ehhez a kulcstartóhoz. Ha az új kulcstartó létrehozásakor nincs érték (igaz vagy hamis) értékre állítva, akkor alapértelmezés szerint igaz értékre lesz állítva. Ha igaz értékre van állítva, nem állítható vissza hamis értékre. |
enabledForDeployment |
boolean |
Tulajdonság annak megadásához, hogy az Azure Virtual Machines jogosult-e titkos kulcsként tárolt tanúsítványok lekérésére a kulcstartóból. |
|
enabledForDiskEncryption |
boolean |
Tulajdonság annak megadásához, hogy az Azure Disk Encryption lekérheti-e a titkos kulcsokat a tárolóból és a kulcsokat. |
|
enabledForTemplateDeployment |
boolean |
Tulajdonság annak megadásához, hogy az Azure Resource Manager jogosult-e titkos kulcsokat lekérni a kulcstartóból. |
|
hsmPoolResourceId |
string |
A HSM-készlet erőforrás-azonosítója. |
|
networkAcls |
A kulcstartó adott hálózati helyekről való elérhetőségére vonatkozó szabályok. |
||
privateEndpointConnections |
A kulcstartóhoz társított privát végponti kapcsolatok listája. |
||
provisioningState |
A tároló kiépítési állapota. |
||
publicNetworkAccess |
string |
enabled |
Tulajdonság annak megadásához, hogy a tároló fogadja-e a nyilvános internetről érkező forgalmat. Ha "letiltva" értékre van állítva, a privát végponti forgalom kivételével az összes forgalom le lesz tiltva, amely megbízható szolgáltatásokból származik. Ez felülbírálja a beállított tűzfalszabályokat, ami azt jelenti, hogy még ha a tűzfalszabályok is jelen vannak, nem fogjuk tiszteletben tartani a szabályokat. |
sku |
Termékváltozat részletei |
||
softDeleteRetentionInDays |
integer |
90 |
softDelete adatmegőrzési napok. =7 és <=90 értékeket >fogad el. |
tenantId |
string |
Az Azure Active Directory-bérlőazonosító, amelyet a key vaultba irányuló kérések hitelesítéséhez kell használni. |
|
vaultUri |
string |
A tároló URI-ja a kulcsokon és titkos kulcsokon végzett műveletek végrehajtásához. |
VaultProvisioningState
A tároló kiépítési állapota.
Name | Típus | Description |
---|---|---|
RegisteringDns |
string |
|
Succeeded |
string |
VirtualNetworkRule
Egy adott virtuális hálózatból származó tároló akadálymentességét szabályozó szabály.
Name | Típus | Description |
---|---|---|
id |
string |
Egy virtuális hálózat alhálózatának teljes erőforrás-azonosítója, például "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". |
ignoreMissingVnetServiceEndpoint |
boolean |
Tulajdonság annak megadásához, hogy az NRP figyelmen kívül hagyja-e annak ellenőrzését, hogy a szülő alhálózat rendelkezik-e serviceEndpoints konfigurálásával. |