Delen via


Vaults - List By Subscription

De lijstbewerking haalt informatie op over de kluizen die aan het abonnement zijn gekoppeld.

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

URI-parameters

Name In Vereist Type Description
subscriptionId
path True

string

Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.

api-version
query True

string

Client-API-versie.

$top
query

integer (int32)

Maximum aantal resultaten dat moet worden geretourneerd.

Antwoorden

Name Type Description
200 OK

VaultListResult

Informatie ophalen over alle sleutelkluizen in het opgegeven abonnement.

Other Status Codes

CloudError

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

List vaults in the specified subscription

Voorbeeldaanvraag

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/vaults?$top=1&api-version=2022-07-01

Voorbeeldrespons

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

Definities

Name Description
AccessPolicyEntry

Een identiteit die toegang heeft tot de sleutelkluis. Alle identiteiten in de matrix moeten dezelfde tenant-id gebruiken als de tenant-id van de sleutelkluis.

ActionsRequired

Een bericht dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen.

CertificatePermissions

Machtigingen voor certificaten

CloudError

Een foutreactie van de Key Vault-resourceprovider

CloudErrorBody

Een foutreactie van de Key Vault-resourceprovider

CreateMode

De maakmodus van de kluis om aan te geven of de kluis moet worden hersteld of niet.

identityType

Het type identiteit waarmee de sleutelkluisresource is gemaakt.

IPRule

Een regel voor de toegankelijkheid van een kluis vanuit een specifiek IP-adres of IP-bereik.

KeyPermissions

Machtigingen voor sleutels

NetworkRuleAction

De standaardactie wanneer geen regel van ipRules en van virtualNetworkRules overeenkomt. Dit wordt alleen gebruikt nadat de bypass-eigenschap is geëvalueerd.

NetworkRuleBypassOptions

Hiermee wordt aangegeven welk verkeer netwerkregels kan omzeilen. Dit kan 'AzureServices' of 'Geen' zijn. Als de standaardwaarde niet is opgegeven, is 'AzureServices'.

NetworkRuleSet

Een set regels voor de netwerktoegankelijkheid van een kluis.

Permissions

Machtigingen die de identiteit heeft voor sleutels, geheimen, certificaten en opslag.

PrivateEndpoint

Eigenschappen van privé-eindpuntobjecten.

PrivateEndpointConnectionItem

Privé-eindpuntverbindingsitem.

PrivateEndpointConnectionProvisioningState

De huidige inrichtingsstatus.

PrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.

PrivateLinkServiceConnectionState

Een object dat de goedkeuringsstatus van de private link-verbinding vertegenwoordigt.

SecretPermissions

Machtigingen voor geheimen

Sku

SKU-details

SkuFamily

Familienaam van SKU

SkuName

SKU-naam om op te geven of de sleutelkluis een standaardkluis of een Premium-kluis is.

StoragePermissions

Machtigingen voor opslagaccounts

SystemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de sleutelkluisresource.

Vault

Resourcegegevens met uitgebreide details.

VaultListResult

Lijst met kluizen

VaultProperties

Eigenschappen van de kluis

VaultProvisioningState

Inrichtingsstatus van de kluis.

VirtualNetworkRule

Een regel voor de toegankelijkheid van een kluis vanuit een specifiek virtueel netwerk.

AccessPolicyEntry

Een identiteit die toegang heeft tot de sleutelkluis. Alle identiteiten in de matrix moeten dezelfde tenant-id gebruiken als de tenant-id van de sleutelkluis.

Name Type Description
applicationId

string (uuid)

Toepassings-id van de clientaanvraag namens een principal

objectId

string

De object-id van een gebruiker, service-principal of beveiligingsgroep in de Azure Active Directory-tenant voor de kluis. De object-id moet uniek zijn voor de lijst met toegangsbeleidsregels.

permissions

Permissions

Machtigingen die de identiteit heeft voor sleutels, geheimen en certificaten.

tenantId

string (uuid)

De tenant-id van Azure Active Directory die moet worden gebruikt voor het verifiëren van aanvragen bij de sleutelkluis.

ActionsRequired

Een bericht dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen.

Waarde Description
None

CertificatePermissions

Machtigingen voor certificaten

Waarde Description
all
backup
create
delete
deleteissuers
get
getissuers
import
list
listissuers
managecontacts
manageissuers
purge
recover
restore
setissuers
update

CloudError

Een foutreactie van de Key Vault-resourceprovider

Name Type Description
error

CloudErrorBody

Een foutreactie van de Key Vault-resourceprovider

CloudErrorBody

Een foutreactie van de Key Vault-resourceprovider

Name Type Description
code

string

Foutcode. Dit is een mnemonic die programmatisch kan worden verbruikt.

message

string

Gebruiksvriendelijk foutbericht. Het bericht is doorgaans gelokaliseerd en kan variëren met de serviceversie.

CreateMode

De maakmodus van de kluis om aan te geven of de kluis moet worden hersteld of niet.

Waarde Description
default
recover

identityType

Het type identiteit waarmee de sleutelkluisresource is gemaakt.

Waarde Description
Application
Key
ManagedIdentity
User

IPRule

Een regel voor de toegankelijkheid van een kluis vanuit een specifiek IP-adres of IP-bereik.

Name Type Description
value

string

Een IPv4-adresbereik in CIDR-notatie, zoals '124.56.78.91' (eenvoudig IP-adres) of '124.56.78.0/24' (alle adressen die beginnen met 124.56.78).

KeyPermissions

Machtigingen voor sleutels

Waarde Description
all
backup
create
decrypt
delete
encrypt
get
getrotationpolicy
import
list
purge
recover
release
restore
rotate
setrotationpolicy
sign
unwrapKey
update
verify
wrapKey

NetworkRuleAction

De standaardactie wanneer geen regel van ipRules en van virtualNetworkRules overeenkomt. Dit wordt alleen gebruikt nadat de bypass-eigenschap is geëvalueerd.

Waarde Description
Allow
Deny

NetworkRuleBypassOptions

Hiermee wordt aangegeven welk verkeer netwerkregels kan omzeilen. Dit kan 'AzureServices' of 'Geen' zijn. Als de standaardwaarde niet is opgegeven, is 'AzureServices'.

Waarde Description
AzureServices
None

NetworkRuleSet

Een set regels voor de netwerktoegankelijkheid van een kluis.

Name Type Description
bypass

NetworkRuleBypassOptions

Hiermee wordt aangegeven welk verkeer netwerkregels kan omzeilen. Dit kan 'AzureServices' of 'Geen' zijn. Als de standaardwaarde niet is opgegeven, is 'AzureServices'.

defaultAction

NetworkRuleAction

De standaardactie wanneer geen regel van ipRules en van virtualNetworkRules overeenkomt. Dit wordt alleen gebruikt nadat de bypass-eigenschap is geëvalueerd.

ipRules

IPRule[]

De lijst met IP-adresregels.

virtualNetworkRules

VirtualNetworkRule[]

De lijst met regels voor virtuele netwerken.

Permissions

Machtigingen die de identiteit heeft voor sleutels, geheimen, certificaten en opslag.

Name Type Description
certificates

CertificatePermissions[]

Machtigingen voor certificaten

keys

KeyPermissions[]

Machtigingen voor sleutels

secrets

SecretPermissions[]

Machtigingen voor geheimen

storage

StoragePermissions[]

Machtigingen voor opslagaccounts

PrivateEndpoint

Eigenschappen van privé-eindpuntobjecten.

Name Type Description
id

string

Volledige id van de privé-eindpuntresource.

PrivateEndpointConnectionItem

Privé-eindpuntverbindingsitem.

Name Type Description
etag

string

Gewijzigd wanneer er een wijziging is in de status van de privé-eindpuntverbinding.

id

string

Id van privé-eindpuntverbinding.

properties.privateEndpoint

PrivateEndpoint

Eigenschappen van het privé-eindpuntobject.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Goedkeuringsstatus van de private link-verbinding.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Inrichtingsstatus van de privé-eindpuntverbinding.

PrivateEndpointConnectionProvisioningState

De huidige inrichtingsstatus.

Waarde Description
Creating
Deleting
Disconnected
Failed
Succeeded
Updating

PrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.

Waarde Description
Approved
Disconnected
Pending
Rejected

PrivateLinkServiceConnectionState

Een object dat de goedkeuringsstatus van de private link-verbinding vertegenwoordigt.

Name Type Description
actionsRequired

ActionsRequired

Een bericht dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen.

description

string

De reden voor goedkeuring of afwijzing.

status

PrivateEndpointServiceConnectionStatus

Geeft aan of de verbinding is goedgekeurd, geweigerd of verwijderd door de eigenaar van de sleutelkluis.

SecretPermissions

Machtigingen voor geheimen

Waarde Description
all
backup
delete
get
list
purge
recover
restore
set

Sku

SKU-details

Name Type Description
family

SkuFamily

Familienaam van SKU

name

SkuName

SKU-naam om op te geven of de sleutelkluis een standaardkluis of een Premium-kluis is.

SkuFamily

Familienaam van SKU

Waarde Description
A

SkuName

SKU-naam om op te geven of de sleutelkluis een standaardkluis of een Premium-kluis is.

Waarde Description
premium
standard

StoragePermissions

Machtigingen voor opslagaccounts

Waarde Description
all
backup
delete
deletesas
get
getsas
list
listsas
purge
recover
regeneratekey
restore
set
setsas
update

SystemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de sleutelkluisresource.

Name Type Description
createdAt

string (date-time)

De tijdstempel van het maken van de sleutelkluisresource (UTC).

createdBy

string

De identiteit die de sleutelkluisresource heeft gemaakt.

createdByType

identityType

Het type identiteit waarmee de sleutelkluisresource is gemaakt.

lastModifiedAt

string (date-time)

De tijdstempel van de laatste wijziging van de sleutelkluisresource (UTC).

lastModifiedBy

string

De identiteit die de sleutelkluisresource voor het laatst heeft gewijzigd.

lastModifiedByType

identityType

Het type identiteit dat de sleutelkluisresource voor het laatst heeft gewijzigd.

Vault

Resourcegegevens met uitgebreide details.

Name Type Description
id

string

Volledig gekwalificeerde id van de sleutelkluisresource.

location

string

Azure-locatie van de sleutelkluisresource.

name

string

Naam van de sleutelkluisresource.

properties

VaultProperties

Eigenschappen van de kluis

systemData

SystemData

Systeemmetagegevens voor de sleutelkluis.

tags

object

Tags die zijn toegewezen aan de sleutelkluisresource.

type

string

Resourcetype van de sleutelkluisresource.

VaultListResult

Lijst met kluizen

Name Type Description
nextLink

string

De URL voor het ophalen van de volgende set kluizen.

value

Vault[]

De lijst met kluizen.

VaultProperties

Eigenschappen van de kluis

Name Type Default value Description
accessPolicies

AccessPolicyEntry[]

Een matrix van 0 tot 1024 identiteiten die toegang hebben tot de sleutelkluis. Alle identiteiten in de matrix moeten dezelfde tenant-id gebruiken als de tenant-id van de sleutelkluis. Wanneer createMode is ingesteld op recover, zijn toegangsbeleidsregels niet vereist. Anders zijn toegangsbeleidsregels vereist.

createMode

CreateMode

De maakmodus van de kluis om aan te geven of de kluis moet worden hersteld of niet.

enablePurgeProtection

boolean

Eigenschap die aangeeft of beveiliging tegen opschonen is ingeschakeld voor deze kluis. Als u deze eigenschap instelt op true, wordt de beveiliging tegen opschoning voor deze kluis en de inhoud ervan geactiveerd. Alleen de Key Vault-service kan een harde, onherstelbare verwijdering initiëren. De instelling is alleen van kracht als voorlopig verwijderen ook is ingeschakeld. Het inschakelen van deze functionaliteit kan niet ongedaan worden genomen. De eigenschap accepteert dus geen onwaar als waarde.

enableRbacAuthorization

boolean

False

Eigenschap die bepaalt hoe gegevensacties worden geautoriseerd. Wanneer waar, gebruikt de sleutelkluis op rollen gebaseerd toegangsbeheer (RBAC) voor autorisatie van gegevensacties en worden de toegangsbeleidsregels die zijn opgegeven in kluiseigenschappen genegeerd. Als deze onwaar is, gebruikt de sleutelkluis het toegangsbeleid dat is opgegeven in kluiseigenschappen en worden alle beleidsregels die zijn opgeslagen in Azure Resource Manager genegeerd. Als null of niet is opgegeven, wordt de kluis gemaakt met de standaardwaarde false. Beheeracties worden altijd geautoriseerd met RBAC.

enableSoftDelete

boolean

True

Eigenschap om op te geven of de functionaliteit voorlopig verwijderen is ingeschakeld voor deze sleutelkluis. Als deze niet is ingesteld op een waarde (waar of onwaar) bij het maken van een nieuwe sleutelkluis, wordt deze standaard ingesteld op true. Zodra deze is ingesteld op waar, kan deze niet meer worden teruggezet naar onwaar.

enabledForDeployment

boolean

Eigenschap om op te geven of virtuele Azure-machines certificaten mogen ophalen die zijn opgeslagen als geheimen uit de sleutelkluis.

enabledForDiskEncryption

boolean

Eigenschap om op te geven of Azure Disk Encryption geheimen mag ophalen uit de kluis en sleutels uitpakken.

enabledForTemplateDeployment

boolean

Eigenschap om op te geven of Azure Resource Manager geheimen mag ophalen uit de sleutelkluis.

hsmPoolResourceId

string

De resource-id van de HSM-pool.

networkAcls

NetworkRuleSet

Regels voor de toegankelijkheid van de sleutelkluis vanaf specifieke netwerklocaties.

privateEndpointConnections

PrivateEndpointConnectionItem[]

Lijst met privé-eindpuntverbindingen die zijn gekoppeld aan de sleutelkluis.

provisioningState

VaultProvisioningState

Inrichtingsstatus van de kluis.

publicNetworkAccess

string

enabled

Eigenschap om op te geven of de kluis verkeer van openbaar internet accepteert. Als dit is ingesteld op 'uitgeschakeld' van al het verkeer, met uitzondering van privé-eindpuntverkeer en dat afkomstig is van vertrouwde services, wordt geblokkeerd. Hierdoor worden de ingestelde firewallregels overschreven, wat betekent dat zelfs als de firewallregels aanwezig zijn, we de regels niet zullen respecteren.

sku

Sku

SKU-details

softDeleteRetentionInDays

integer (int32)

90

softDelete-gegevensretentiedagen. Het accepteert >=7 en <=90.

tenantId

string (uuid)

De tenant-id van Azure Active Directory die moet worden gebruikt voor het verifiëren van aanvragen bij de sleutelkluis.

vaultUri

string

De URI van de kluis voor het uitvoeren van bewerkingen op sleutels en geheimen.

VaultProvisioningState

Inrichtingsstatus van de kluis.

Waarde Description
RegisteringDns
Succeeded

VirtualNetworkRule

Een regel voor de toegankelijkheid van een kluis vanuit een specifiek virtueel netwerk.

Name Type Description
id

string

Volledige resource-id van een vnet-subnet, zoals '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.

ignoreMissingVnetServiceEndpoint

boolean

Eigenschap om op te geven of NRP de controle negeert als bovenliggend subnet serviceEndpoints heeft geconfigureerd.