Vaults - List By Resource Group

Dienst:

Key Vault

API-Version:

2022-07-01

Der List-Vorgang ruft Informationen zu den Tresoren ab, die dem Abonnement und innerhalb der angegebenen Ressourcengruppe zugeordnet sind.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults?api-version=2022-07-01

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults?$top={$top}&api-version=2022-07-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, zu der der Tresor gehört.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.
$top	query		integer int32	Maximale Anzahl der zurückzugebenden Ergebnisse.

Antworten

Name	Typ	Beschreibung
200 OK	VaultListResult	Rufen Sie Informationen zu allen Schlüsseltresoren in der angegebenen Ressourcengruppe ab.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Beispiele

List vaults in the specified resource group

Beispielanforderung

HTTP

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python list_vault_by_resource_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.vaults.list_by_resource_group(
        resource_group_name="sample-group",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/listVaultByResourceGroup.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:

200

{
  "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/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults?api-version=2022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

Definitionen

Name	Beschreibung
AccessPolicyEntry	Eine Identität, die Zugriff auf den Schlüsseltresor hat. Alle Identitäten im Array müssen dieselbe Mandanten-ID wie die Mandanten-ID des Schlüsseltresors verwenden.
ActionsRequired	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.
CertificatePermissions	Berechtigungen für Zertifikate
CloudError	Eine Fehlerantwort von Key Vault Ressourcenanbieter
CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter
CreateMode	Der Erstellungsmodus des Tresors, um anzugeben, ob der Tresor wiederhergestellt werden muss oder nicht.
identityType	Der Identitätstyp, der die Schlüsseltresorressource erstellt hat.
IPRule	Eine Regel, die die Barrierefreiheit eines Tresors über eine bestimmte IP-Adresse oder einen bestimmten IP-Bereich regelt.
KeyPermissions	Berechtigungen für Schlüssel
NetworkRuleAction	Die Standardaktion, wenn keine Regel von ipRules und virtualNetworkRules übereinstimmen. Dies wird erst verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.
NetworkRuleBypassOptions	Gibt an, welcher Datenverkehr Netzwerkregeln umgehen kann. Dies kann "AzureServices" oder "None" sein. Wenn nicht angegeben, lautet der Standardwert "AzureServices".
NetworkRuleSet	Eine Reihe von Regeln, die die Netzwerkzugriffsmöglichkeit eines Tresors regeln.
Permissions	Berechtigungen, die die Identität für Schlüssel, Geheimnisse, Zertifikate und Speicher hat.
PrivateEndpoint	Eigenschaften des privaten Endpunktobjekts.
PrivateEndpointConnectionItem	Verbindungselement für private Endpunkte.
PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus.
PrivateEndpointServiceConnectionStatus	Die private Endpunktverbindung status.
PrivateLinkServiceConnectionState	Ein -Objekt, das den Genehmigungsstatus der Private Link-Verbindung darstellt.
SecretPermissions	Berechtigungen für Geheimnisse
Sku	SKU-Details
SkuFamily	SKU-Familienname
SkuName	SKU-Name, um anzugeben, ob es sich bei dem Schlüsseltresor um einen Standardtresor oder einen Premium-Tresor handelt.
StoragePermissions	Berechtigungen für Speicherkonten
SystemData	Metadaten zur Erstellung und letzten Änderung der Schlüsseltresorressource.
Vault	Ressourceninformationen mit erweiterten Details.
VaultListResult	Liste der Tresore
VaultProperties	Eigenschaften des Tresors
VaultProvisioningState	Bereitstellungsstatus des Tresors.
VirtualNetworkRule	Eine Regel, die die Barrierefreiheit eines Tresors über ein bestimmtes virtuelles Netzwerk regelt.

AccessPolicyEntry

Eine Identität, die Zugriff auf den Schlüsseltresor hat. Alle Identitäten im Array müssen dieselbe Mandanten-ID wie die Mandanten-ID des Schlüsseltresors verwenden.

Name	Typ	Beschreibung
applicationId	string	Anwendungs-ID des Clients, der eine Anforderung im Auftrag eines Prinzipals stellt
objectId	string	Die Objekt-ID eines Benutzers, Eines Dienstprinzipals oder einer Sicherheitsgruppe im Azure Active Directory-Mandanten für den Tresor. Die Objekt-ID muss für die Liste der Zugriffsrichtlinien eindeutig sein.
permissions	Permissions	Berechtigungen, über die die Identität für Schlüssel, Geheimnisse und Zertifikate verfügt.
tenantId	string	Die Azure Active Directory-Mandanten-ID, die zum Authentifizieren von Anforderungen an den Schlüsseltresor verwendet werden soll.

ActionsRequired

Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.

Name	Typ	Beschreibung
None	string

CertificatePermissions

Berechtigungen für Zertifikate

Name	Typ	Beschreibung
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

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter

CloudErrorBody

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
code	string	Fehlercode Dies ist ein mnemonisches, das programmgesteuert genutzt werden kann.
message	string	Benutzerfreundliche Fehlermeldung. Die Nachricht ist in der Regel lokalisiert und kann je nach Dienstversion variieren.

CreateMode

Der Erstellungsmodus des Tresors, um anzugeben, ob der Tresor wiederhergestellt werden muss oder nicht.

Name	Typ	Beschreibung
default	string
recover	string

identityType

Der Identitätstyp, der die Schlüsseltresorressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

IPRule

Eine Regel, die die Barrierefreiheit eines Tresors über eine bestimmte IP-Adresse oder einen bestimmten IP-Bereich regelt.

Name	Typ	Beschreibung
value	string	Ein IPv4-Adressbereich in CIDR-Notation, z. B. "124.56.78.91" (einfache IP-Adresse) oder "124.56.78.0/24" (alle Adressen, die mit 124.56.78 beginnen).

KeyPermissions

Berechtigungen für Schlüssel

Name	Typ	Beschreibung
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

Die Standardaktion, wenn keine Regel von ipRules und virtualNetworkRules übereinstimmen. Dies wird erst verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.

Name	Typ	Beschreibung
Allow	string
Deny	string

NetworkRuleBypassOptions

Gibt an, welcher Datenverkehr Netzwerkregeln umgehen kann. Dies kann "AzureServices" oder "None" sein. Wenn nicht angegeben, lautet der Standardwert "AzureServices".

Name	Typ	Beschreibung
AzureServices	string
None	string

NetworkRuleSet

Eine Reihe von Regeln, die die Netzwerkzugriffsmöglichkeit eines Tresors regeln.

Name	Typ	Beschreibung
bypass	NetworkRuleBypassOptions	Gibt an, welcher Datenverkehr Netzwerkregeln umgehen kann. Dies kann "AzureServices" oder "None" sein. Wenn nicht angegeben, lautet der Standardwert "AzureServices".
defaultAction	NetworkRuleAction	Die Standardaktion, wenn keine Regel von ipRules und virtualNetworkRules übereinstimmen. Dies wird erst verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.
ipRules	IPRule[]	Die Liste der IP-Adressregeln.
virtualNetworkRules	VirtualNetworkRule[]	Die Liste der Regeln für virtuelle Netzwerke.

Permissions

Berechtigungen, die die Identität für Schlüssel, Geheimnisse, Zertifikate und Speicher hat.

Name	Typ	Beschreibung
certificates	CertificatePermissions[]	Berechtigungen für Zertifikate
keys	KeyPermissions[]	Berechtigungen für Schlüssel
secrets	SecretPermissions[]	Berechtigungen für Geheimnisse
storage	StoragePermissions[]	Berechtigungen für Speicherkonten

PrivateEndpoint

Eigenschaften des privaten Endpunktobjekts.

Name	Typ	Beschreibung
id	string	Vollständiger Bezeichner der privaten Endpunktressource.

PrivateEndpointConnectionItem

Verbindungselement für private Endpunkte.

Name	Typ	Beschreibung
etag	string	Wird immer dann geändert, wenn sich der Status der Verbindung mit privaten Endpunkten ändert.
id	string	ID der Verbindung mit einem privaten Endpunkt.
properties.privateEndpoint	PrivateEndpoint	Eigenschaften des privaten Endpunktobjekts.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Genehmigungsstatus der Verbindung mit privatem Link.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.

PrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.

Name	Typ	Beschreibung
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Die private Endpunktverbindung status.

Name	Typ	Beschreibung
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Ein -Objekt, das den Genehmigungsstatus der Private Link-Verbindung darstellt.

Name	Typ	Beschreibung
actionsRequired	ActionsRequired	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.
description	string	Der Grund für die Genehmigung oder Ablehnung.
status	PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Schlüsseltresors genehmigt, abgelehnt oder entfernt wurde.

SecretPermissions

Berechtigungen für Geheimnisse

Name	Typ	Beschreibung
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	string

Sku

SKU-Details

Name	Typ	Beschreibung
family	SkuFamily	SKU-Familienname
name	SkuName	SKU-Name, um anzugeben, ob es sich bei dem Schlüsseltresor um einen Standardtresor oder einen Premium-Tresor handelt.

SkuFamily

SKU-Familienname

Name	Typ	Beschreibung
A	string

SkuName

SKU-Name, um anzugeben, ob es sich bei dem Schlüsseltresor um einen Standardtresor oder einen Premium-Tresor handelt.

Name	Typ	Beschreibung
premium	string
standard	string

StoragePermissions

Berechtigungen für Speicherkonten

Name	Typ	Beschreibung
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

Metadaten zur Erstellung und letzten Änderung der Schlüsseltresorressource.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Schlüsseltresorressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Schlüsseltresorressource erstellt hat.
createdByType	identityType	Der Identitätstyp, der die Schlüsseltresorressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung (UTC) der Schlüsseltresorressource.
lastModifiedBy	string	Die Identität, die die Schlüsseltresorressource zuletzt geändert hat.
lastModifiedByType	identityType	Der Identitätstyp, der die Schlüsseltresorressource zuletzt geändert hat.

Vault

Ressourceninformationen mit erweiterten Details.

Name	Typ	Beschreibung
id	string	Vollqualifizierter Bezeichner der Schlüsseltresorressource.
location	string	Azure-Speicherort der Schlüsseltresorressource.
name	string	Name der Schlüsseltresorressource.
properties	VaultProperties	Eigenschaften des Tresors
systemData	SystemData	Systemmetadaten für den Schlüsseltresor.
tags	object	Tags, die der Schlüsseltresorressource zugewiesen sind.
type	string	Ressourcentyp der Schlüsseltresorressource.

VaultListResult

Liste der Tresore

Name	Typ	Beschreibung
nextLink	string	Die URL zum Abrufen der nächsten Gruppe von Tresoren.
value	Vault[]	Die Liste der Tresore.

VaultProperties

Eigenschaften des Tresors

Name	Typ	Standardwert	Beschreibung
accessPolicies	AccessPolicyEntry[]		Ein Array von 0 bis 1024 Identitäten, die Zugriff auf den Schlüsseltresor haben. Alle Identitäten im Array müssen dieselbe Mandanten-ID wie die Mandanten-ID des Schlüsseltresors verwenden. Wenn createMode auf recoverfestgelegt ist, sind Zugriffsrichtlinien nicht erforderlich. Andernfalls sind Zugriffsrichtlinien erforderlich.
createMode	CreateMode		Der Erstellungsmodus des Tresors, um anzugeben, ob der Tresor wiederhergestellt werden muss oder nicht.
enablePurgeProtection	boolean		Eigenschaft, die angibt, ob der Schutz vor Bereinigung für diesen Tresor aktiviert ist. Wenn Sie diese Eigenschaft auf true festlegen, wird der Schutz vor der Bereinigung für diesen Tresor und seinen Inhalt aktiviert. Nur der Key Vault-Dienst kann ein hartes, unwiederbringliches Löschen initiieren. Die Einstellung ist nur wirksam, wenn das vorläufige Löschen ebenfalls aktiviert ist. Das Aktivieren dieser Funktion ist nicht rückgängig gemacht, d. h. die Eigenschaft akzeptiert false nicht als Wert.
enableRbacAuthorization	boolean	False	Eigenschaft, die steuert, wie Datenaktionen autorisiert werden. Bei true verwendet der Schlüsseltresor rollenbasierte Access Control (RBAC) für die Autorisierung von Datenaktionen, und die in den Tresoreigenschaften angegebenen Zugriffsrichtlinien werden ignoriert. Bei false verwendet der Schlüsseltresor die in den Tresoreigenschaften angegebenen Zugriffsrichtlinien, und alle in Azure Resource Manager gespeicherten Richtlinien werden ignoriert. Wenn NULL oder nicht angegeben ist, wird der Tresor mit dem Standardwert false erstellt. Beachten Sie, dass Verwaltungsaktionen immer mit RBAC autorisiert werden.
enableSoftDelete	boolean	True	Eigenschaft, um anzugeben, ob die Funktion "vorläufiges Löschen" für diesen Schlüsseltresor aktiviert ist. Wenn beim Erstellen eines neuen Schlüsseltresors kein Wert (true oder false) festgelegt ist, wird er standardmäßig auf TRUE festgelegt. Sobald sie auf TRUE festgelegt wurde, kann sie nicht auf false zurückgesetzt werden.
enabledForDeployment	boolean		Eigenschaft, um anzugeben, ob Azure Virtual Machines zertifikate abrufen dürfen, die als Geheimnisse aus dem Schlüsseltresor gespeichert sind.
enabledForDiskEncryption	boolean		Eigenschaft, um anzugeben, ob Azure Disk Encryption Geheimnisse aus dem Tresor abrufen und Schlüssel entpacken darf.
enabledForTemplateDeployment	boolean		Eigenschaft, um anzugeben, ob Azure Resource Manager Geheimnisse aus dem Schlüsseltresor abrufen darf.
hsmPoolResourceId	string		Die Ressourcen-ID des HSM-Pools.
networkAcls	NetworkRuleSet		Regeln für die Barrierefreiheit des Schlüsseltresors von bestimmten Netzwerkstandorten aus.
privateEndpointConnections	PrivateEndpointConnectionItem[]		Liste der privaten Endpunktverbindungen, die dem Schlüsseltresor zugeordnet sind.
provisioningState	VaultProvisioningState		Bereitstellungsstatus des Tresors.
publicNetworkAccess	string	enabled	Eigenschaft, um anzugeben, ob der Tresor Datenverkehr aus dem öffentlichen Internet akzeptiert. Wenn auf "deaktiviert" festgelegt ist, wird der gesamte Datenverkehr mit Ausnahme des privaten Endpunktdatenverkehrs, der von vertrauenswürdigen Diensten stammt, blockiert. Dadurch werden die festgelegten Firewallregeln außer Kraft gesetzt, was bedeutet, dass wir die Regeln nicht einhalten, auch wenn die Firewallregeln vorhanden sind.
sku	Sku		SKU-Details
softDeleteRetentionInDays	integer	90	softDelete Datenaufbewahrungstage. Sie akzeptiert >=7 und <=90.
tenantId	string		Die Azure Active Directory-Mandanten-ID, die zum Authentifizieren von Anforderungen an den Schlüsseltresor verwendet werden soll.
vaultUri	string		Der URI des Tresors zum Ausführen von Vorgängen für Schlüssel und Geheimnisse.

VaultProvisioningState

Bereitstellungsstatus des Tresors.

Name	Typ	Beschreibung
RegisteringDns	string
Succeeded	string

VirtualNetworkRule

Eine Regel, die die Barrierefreiheit eines Tresors über ein bestimmtes virtuelles Netzwerk regelt.

Name	Typ	Beschreibung
id	string	Vollständige Ressourcen-ID eines VNET-Subnetzes, z. B. "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnets/subnet1".
ignoreMissingVnetServiceEndpoint	boolean	Eigenschaft, um anzugeben, ob nrp die Überprüfung ignoriert, ob für das übergeordnete Subnetz serviceEndpoints konfiguriert ist.