Vaults - List By Subscription
Operace List získá informace o trezorech přidružených k předplatnému.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/vaults?api-version=2022-07-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/vaults?$top={$top}&api-version=2022-07-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby. |
api-version
|
query | True |
string |
Verze rozhraní API klienta. |
$top
|
query |
integer int32 |
Maximální počet vrácených výsledků |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Získejte informace o všech trezorech klíčů v zadaném předplatném. |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Příklady
List vaults in the specified subscription
Sample Request
Sample Response
{
"value": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-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": "premium"
},
"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,
"enableSoftDelete": true,
"hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
"vaultUri": "https://sample-vault.vault.azure.net/",
"provisioningState": "Succeeded"
}
}
],
"nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resources?api-version=22022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}
Definice
Name | Description |
---|---|
Access |
Identita, která má přístup k trezoru klíčů. Všechny identity v poli musí používat stejné ID tenanta jako ID tenanta trezoru klíčů. |
Actions |
Zpráva s informací, že změny poskytovatele služeb vyžadují aktualizace příjemce. |
Certificate |
Oprávnění k certifikátům |
Cloud |
Chybová odpověď od poskytovatele prostředků Key Vault |
Cloud |
Chybová odpověď od poskytovatele prostředků Key Vault |
Create |
Režim vytvoření trezoru označuje, jestli je potřeba trezor obnovit, nebo ne. |
identity |
Typ identity, která vytvořila prostředek trezoru klíčů. |
IPRule |
Pravidlo, které řídí přístupnost trezoru z konkrétní IP adresy nebo rozsahu IP adres. |
Key |
Oprávnění ke klíčům |
Network |
Výchozí akce, pokud se žádné pravidlo z ipRules a z virtualNetworkRules neshoduje. Použije se pouze po vyhodnocení vlastnosti bypass. |
Network |
Udává, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud není zadáno, výchozí hodnota je AzureServices. |
Network |
Sada pravidel, která řídí přístupnost sítě trezoru. |
Permissions |
Oprávnění, která identita má pro klíče, tajné kódy, certifikáty a úložiště. |
Private |
Vlastnosti objektu privátního koncového bodu. |
Private |
Položka připojení privátního koncového bodu. |
Private |
Aktuální stav zřizování. |
Private |
Stav připojení privátního koncového bodu. |
Private |
Objekt, který představuje stav schválení připojení privátního propojení. |
Secret |
Oprávnění k tajným kódům |
Sku |
Podrobnosti o skladové pořidce |
Sku |
Název rodiny skladové položky |
Sku |
Název skladové položky určující, jestli je trezor klíčů trezorem úrovně Standard nebo trezorem úrovně Premium. |
Storage |
Oprávnění k účtům úložiště |
System |
Metadata týkající se vytvoření a poslední změny prostředku trezoru klíčů |
Vault |
Informace o zdroji s rozšířenými podrobnostmi |
Vault |
Seznam trezorů |
Vault |
Vlastnosti trezoru |
Vault |
Stav zřizování trezoru. |
Virtual |
Pravidlo, které řídí přístupnost trezoru z konkrétní virtuální sítě. |
AccessPolicyEntry
Identita, která má přístup k trezoru klíčů. Všechny identity v poli musí používat stejné ID tenanta jako ID tenanta trezoru klíčů.
Name | Typ | Description |
---|---|---|
applicationId |
string |
ID aplikace klienta, který žádá jménem objektu zabezpečení |
objectId |
string |
ID objektu uživatele, instančního objektu nebo skupiny zabezpečení v tenantovi Azure Active Directory pro trezor. ID objektu musí být jedinečné pro seznam zásad přístupu. |
permissions |
Oprávnění, která identita má pro klíče, tajné kódy a certifikáty. |
|
tenantId |
string |
ID tenanta Azure Active Directory, které by se mělo použít k ověřování požadavků na trezor klíčů. |
ActionsRequired
Zpráva s informací, že změny poskytovatele služeb vyžadují aktualizace příjemce.
Name | Typ | Description |
---|---|---|
None |
string |
CertificatePermissions
Oprávnění k certifikátům
Name | Typ | 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
Chybová odpověď od poskytovatele prostředků Key Vault
Name | Typ | Description |
---|---|---|
error |
Chybová odpověď od poskytovatele prostředků Key Vault |
CloudErrorBody
Chybová odpověď od poskytovatele prostředků Key Vault
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby Jedná se o mnemotechnický objekt, který je možné využívat programově. |
message |
string |
Uživatelsky přívětivá chybová zpráva. Zpráva je obvykle lokalizovaná a může se lišit podle verze služby. |
CreateMode
Režim vytvoření trezoru označuje, jestli je potřeba trezor obnovit, nebo ne.
Name | Typ | Description |
---|---|---|
default |
string |
|
recover |
string |
identityType
Typ identity, která vytvořila prostředek trezoru klíčů.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
IPRule
Pravidlo, které řídí přístupnost trezoru z konkrétní IP adresy nebo rozsahu IP adres.
Name | Typ | Description |
---|---|---|
value |
string |
Rozsah IPv4 adres v zápisu CIDR, například "124.56.78.91" (jednoduchá IP adresa) nebo "124.56.78.0/24" (všechny adresy, které začínají na 124.56.78). |
KeyPermissions
Oprávnění ke klíčům
Name | Typ | 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
Výchozí akce, pokud se žádné pravidlo z ipRules a z virtualNetworkRules neshoduje. Použije se pouze po vyhodnocení vlastnosti bypass.
Name | Typ | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
NetworkRuleBypassOptions
Udává, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud není zadáno, výchozí hodnota je AzureServices.
Name | Typ | Description |
---|---|---|
AzureServices |
string |
|
None |
string |
NetworkRuleSet
Sada pravidel, která řídí přístupnost sítě trezoru.
Name | Typ | Description |
---|---|---|
bypass |
Udává, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud není zadáno, výchozí hodnota je AzureServices. |
|
defaultAction |
Výchozí akce, pokud se žádné pravidlo z ipRules a z virtualNetworkRules neshoduje. Použije se pouze po vyhodnocení vlastnosti bypass. |
|
ipRules |
IPRule[] |
Seznam pravidel IP adres. |
virtualNetworkRules |
Seznam pravidel virtuální sítě. |
Permissions
Oprávnění, která identita má pro klíče, tajné kódy, certifikáty a úložiště.
Name | Typ | Description |
---|---|---|
certificates |
Oprávnění k certifikátům |
|
keys |
Oprávnění ke klíčům |
|
secrets |
Oprávnění k tajným kódům |
|
storage |
Oprávnění k účtům úložiště |
PrivateEndpoint
Vlastnosti objektu privátního koncového bodu.
Name | Typ | Description |
---|---|---|
id |
string |
Úplný identifikátor prostředku privátního koncového bodu. |
PrivateEndpointConnectionItem
Položka připojení privátního koncového bodu.
Name | Typ | Description |
---|---|---|
etag |
string |
Změněno vždy, když dojde ke změně stavu připojení privátního koncového bodu. |
id |
string |
ID připojení privátního koncového bodu. |
properties.privateEndpoint |
Vlastnosti objektu privátního koncového bodu. |
|
properties.privateLinkServiceConnectionState |
Stav schválení připojení privátního propojení |
|
properties.provisioningState |
Stav zřizování připojení privátního koncového bodu. |
PrivateEndpointConnectionProvisioningState
Aktuální stav zřizování.
Name | Typ | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Disconnected |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
PrivateEndpointServiceConnectionStatus
Stav připojení privátního koncového bodu.
Name | Typ | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
Objekt, který představuje stav schválení připojení privátního propojení.
Name | Typ | Description |
---|---|---|
actionsRequired |
Zpráva s informací, že změny poskytovatele služeb vyžadují aktualizace příjemce. |
|
description |
string |
Důvod schválení nebo zamítnutí. |
status |
Označuje, jestli vlastník trezoru klíčů připojení schválil, odmítl nebo odebral. |
SecretPermissions
Oprávnění k tajným kódům
Name | Typ | Description |
---|---|---|
all |
string |
|
backup |
string |
|
delete |
string |
|
get |
string |
|
list |
string |
|
purge |
string |
|
recover |
string |
|
restore |
string |
|
set |
string |
Sku
Podrobnosti o skladové pořidce
Name | Typ | Description |
---|---|---|
family |
Název rodiny skladové položky |
|
name |
Název skladové položky určující, jestli je trezor klíčů trezorem úrovně Standard nebo trezorem úrovně Premium. |
SkuFamily
Název rodiny skladové položky
Name | Typ | Description |
---|---|---|
A |
string |
SkuName
Název skladové položky určující, jestli je trezor klíčů trezorem úrovně Standard nebo trezorem úrovně Premium.
Name | Typ | Description |
---|---|---|
premium |
string |
|
standard |
string |
StoragePermissions
Oprávnění k účtům úložiště
Name | Typ | 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
Metadata týkající se vytvoření a poslední změny prostředku trezoru klíčů
Name | Typ | Description |
---|---|---|
createdAt |
string |
Časové razítko vytvoření prostředku trezoru klíčů (UTC). |
createdBy |
string |
Identita, která vytvořila prostředek trezoru klíčů. |
createdByType |
Typ identity, která vytvořila prostředek trezoru klíčů. |
|
lastModifiedAt |
string |
Časové razítko poslední změny prostředku trezoru klíčů (UTC). |
lastModifiedBy |
string |
Identita, která naposledy změnila prostředek trezoru klíčů. |
lastModifiedByType |
Typ identity, která naposledy změnila prostředek trezoru klíčů. |
Vault
Informace o zdroji s rozšířenými podrobnostmi
Name | Typ | Description |
---|---|---|
id |
string |
Plně kvalifikovaný identifikátor prostředku trezoru klíčů |
location |
string |
Umístění prostředku trezoru klíčů v Azure |
name |
string |
Název prostředku trezoru klíčů |
properties |
Vlastnosti trezoru |
|
systemData |
Systémová metadata pro trezor klíčů. |
|
tags |
object |
Značky přiřazené k prostředku trezoru klíčů |
type |
string |
Typ prostředku trezoru klíčů. |
VaultListResult
Seznam trezorů
Name | Typ | Description |
---|---|---|
nextLink |
string |
Adresa URL pro získání další sady trezorů. |
value |
Vault[] |
Seznam trezorů. |
VaultProperties
Vlastnosti trezoru
Name | Typ | Výchozí hodnota | Description |
---|---|---|---|
accessPolicies |
Pole identit 0 až 1024, které mají přístup k trezoru klíčů. Všechny identity v poli musí používat stejné ID tenanta jako ID tenanta trezoru klíčů. Pokud |
||
createMode |
Režim vytvoření trezoru označuje, jestli je potřeba trezor obnovit, nebo ne. |
||
enablePurgeProtection |
boolean |
Vlastnost určující, zda je pro tento trezor povolena ochrana před vymazáním. Nastavením této vlastnosti na true aktivujete ochranu před vymazáním tohoto trezoru a jeho obsahu – pouze služba Key Vault může zahájit tvrdé a neodstranitelné odstranění. Nastavení je platné pouze v případě, že je povolené také obnovitelné odstranění. Povolení této funkce je nevratné – to znamená, že vlastnost nepřijímá hodnotu false jako svou hodnotu. |
|
enableRbacAuthorization |
boolean |
False |
Vlastnost, která řídí způsob autorizace akcí dat. Pokud je pravda, trezor klíčů použije k autorizaci akcí dat Access Control na základě role (RBAC) a zásady přístupu zadané ve vlastnostech trezoru budou ignorovány. Pokud je hodnota false, trezor klíčů použije zásady přístupu zadané ve vlastnostech trezoru a všechny zásady uložené v Azure Resource Manager budou ignorovány. Pokud je zadána hodnota null nebo ne, trezor se vytvoří s výchozí hodnotou false. Mějte na paměti, že akce správy jsou vždy autorizované pomocí RBAC. |
enableSoftDelete |
boolean |
True |
Vlastnost určuje, jestli je pro tento trezor klíčů povolená funkce obnovitelného odstranění. Pokud při vytváření nového trezoru klíčů není nastavená žádná hodnota (true nebo false), bude ve výchozím nastavení nastavená na hodnotu true. Jakmile je nastavená hodnota true, nelze ji vrátit na hodnotu false. |
enabledForDeployment |
boolean |
Vlastnost určuje, jestli mají azure Virtual Machines povoleno načítat certifikáty uložené jako tajné kódy z trezoru klíčů. |
|
enabledForDiskEncryption |
boolean |
Vlastnost určuje, jestli má služba Azure Disk Encryption povoleno načítat tajné kódy z trezoru a rozbalovat klíče. |
|
enabledForTemplateDeployment |
boolean |
Vlastnost určuje, jestli má Azure Resource Manager povoleno načítat tajné kódy z trezoru klíčů. |
|
hsmPoolResourceId |
string |
ID prostředku fondu HSM. |
|
networkAcls |
Pravidla pro přístupnost trezoru klíčů z konkrétních síťových umístění |
||
privateEndpointConnections |
Seznam připojení privátních koncových bodů přidružených k trezoru klíčů |
||
provisioningState |
Stav zřizování trezoru. |
||
publicNetworkAccess |
string |
enabled |
Vlastnost určuje, jestli bude trezor přijímat provoz z veřejného internetu. Pokud je nastavená možnost Zakázáno, veškerý provoz s výjimkou provozu privátního koncového bodu a provozu, který pochází z důvěryhodných služeb, se zablokuje. Tím se přepíše nastavená pravidla brány firewall, což znamená, že i když jsou pravidla brány firewall k dispozici, nebudeme je dodržovat. |
sku |
Podrobnosti o skladové pořidce |
||
softDeleteRetentionInDays |
integer |
90 |
softDelete data retention days. >Přijímá =7 a <=90. |
tenantId |
string |
ID tenanta Azure Active Directory, které by se mělo použít k ověřování požadavků na trezor klíčů. |
|
vaultUri |
string |
Identifikátor URI trezoru pro provádění operací s klíči a tajnými klíči |
VaultProvisioningState
Stav zřizování trezoru.
Name | Typ | Description |
---|---|---|
RegisteringDns |
string |
|
Succeeded |
string |
VirtualNetworkRule
Pravidlo, které řídí přístupnost trezoru z konkrétní virtuální sítě.
Name | Typ | Description |
---|---|---|
id |
string |
Úplné ID prostředku podsítě virtuální sítě, například /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1. |
ignoreMissingVnetServiceEndpoint |
boolean |
Vlastnost určuje, jestli bude NRP ignorovat kontrolu, jestli má nadřazená podsíť nakonfigurované serviceEndpoints. |