Vaults - List By Resource Group

Referentie

Service:: Key Vault

API Version:: 2022-07-01

Met de lijstbewerking wordt informatie opgehaald over de kluizen die zijn gekoppeld aan het abonnement en binnen de opgegeven resourcegroep.

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

With optional parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep waartoe de kluis behoort.
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
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 de opgegeven resourcegroep.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

List vaults in the specified resource group

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

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

Sample Response

Status code:: 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=="
}

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 waarin wordt aangegeven of wijzigingen in de serviceprovider updates voor de consument vereisen.
CertificatePermissions	Machtigingen voor certificaten
CloudError	Een foutreactie van Key Vault resourceprovider
CloudErrorBody	Een foutreactie van Key Vault resourceprovider
CreateMode	De modus voor het maken 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 die de toegankelijkheid van een kluis vanaf een specifiek IP-adres of IP-bereik regelt.
KeyPermissions	Machtigingen voor sleutels
NetworkRuleAction	De standaardactie wanneer er geen regel van ipRules en van virtualNetworkRules overeenkomen. Dit wordt alleen gebruikt nadat de bypass-eigenschap is geëvalueerd.
NetworkRuleBypassOptions	Hiermee wordt aangegeven welk verkeer netwerkregels kan omzeilen. Dit kan 'AzureServices' of 'None' zijn. Als dit niet is opgegeven, is de standaardwaarde '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	SKU-familienaam
SkuName	SKU-naam om aan te geven of de sleutelkluis een Standard-kluis of een Premium-kluis is.
StoragePermissions	Machtigingen voor opslagaccounts
SystemData	Metagegevens met betrekking tot het maken en laatste wijzigen 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 die de toegankelijkheid van een kluis vanuit een specifiek virtueel netwerk regelt.

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	Toepassings-id van de client die een aanvraag indient 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	De Azure Active Directory-tenant-id die moet worden gebruikt voor het verifiëren van aanvragen voor de sleutelkluis.

ActionsRequired

Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates voor de consument vereisen.

Name	Type	Description
None	string

CertificatePermissions

Machtigingen voor certificaten

Name	Type	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

Een foutreactie van Key Vault resourceprovider

Name	Type	Description
error	CloudErrorBody	Een foutreactie van Key Vault resourceprovider

CloudErrorBody

Een foutreactie van Key Vault resourceprovider

Name	Type	Description
code	string	Foutcode. Dit is een ezelsbruggetje dat programmatisch kan worden gebruikt.
message	string	Gebruiksvriendelijk foutbericht. Het bericht is doorgaans gelokaliseerd en kan per serviceversie verschillen.

CreateMode

De modus voor het maken van de kluis om aan te geven of de kluis moet worden hersteld of niet.

Name	Type	Description
default	string
recover	string

identityType

Het type identiteit waarmee de sleutelkluisresource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

IPRule

Een regel die de toegankelijkheid van een kluis vanaf een specifiek IP-adres of IP-bereik regelt.

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

Name	Type	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

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

Name	Type	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

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

Name	Type	Description
AzureServices	string
None	string

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 'None' zijn. Als dit niet is opgegeven, is de standaardwaarde 'AzureServices'.
defaultAction	NetworkRuleAction	De standaardactie wanneer er geen regel van ipRules en van virtualNetworkRules overeenkomen. 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.

Name	Type	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Een object dat de goedkeuringsstatus van de Private Link-verbinding vertegenwoordigt.

Name	Type	Description
actionsRequired	ActionsRequired	Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates voor de consument vereisen.
description	string	De reden voor goedkeuring of afwijzing.
status	PrivateEndpointServiceConnectionStatus	Hiermee wordt aangegeven of de verbinding is goedgekeurd, geweigerd of verwijderd door de eigenaar van de sleutelkluis.

SecretPermissions

Machtigingen voor geheimen

Name	Type	Description
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	string

Sku

SKU-details

Name	Type	Description
family	SkuFamily	SKU-familienaam
name	SkuName	SKU-naam om aan te geven of de sleutelkluis een Standard-kluis of een Premium-kluis is.

SkuFamily

SKU-familienaam

Name	Type	Description
A	string

SkuName

SKU-naam om aan te geven of de sleutelkluis een Standard-kluis of een Premium-kluis is.

Name	Type	Description
premium	string
standard	string

StoragePermissions

Machtigingen voor opslagaccounts

Name	Type	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

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

Name	Type	Description
createdAt	string	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	Het tijdstempel van de laatste wijziging van de sleutelkluisresource (UTC).
lastModifiedBy	string	De identiteit die de sleutelkluisresource het laatst heeft gewijzigd.
lastModifiedByType	identityType	Het type identiteit dat de sleutelkluisresource 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	Standaardwaarde	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`, is toegangsbeleid niet vereist. Anders is toegangsbeleid vereist.
createMode	CreateMode		De modus voor het maken 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 beveiliging tegen opschoning voor deze kluis en de inhoud geactiveerd. Alleen de Key Vault-service kan een harde, onherstelbare verwijdering initiëren. De instelling is alleen effectief als voorlopig verwijderen ook is ingeschakeld. Het inschakelen van deze functionaliteit kan niet ongedaan worden gemaakt. Dit betekent dat de eigenschap false niet accepteert als waarde.
enableRbacAuthorization	boolean	False	Eigenschap die bepaalt hoe gegevensacties worden geautoriseerd. Als waar is, gebruikt de sleutelkluis op rollen gebaseerde Access Control (RBAC) voor de autorisatie van gegevensacties en wordt het toegangsbeleid dat is opgegeven in de eigenschappen van de kluis, genegeerd. Wanneer onwaar is, gebruikt de sleutelkluis het toegangsbeleid dat is opgegeven in kluiseigenschappen en wordt elk beleid dat is opgeslagen in Azure Resource Manager genegeerd. Als null of niet is opgegeven, wordt de kluis gemaakt met de standaardwaarde false. Houd er rekening mee dat beheeracties altijd worden 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 true, kan deze niet meer worden teruggezet naar false.
enabledForDeployment	boolean		Eigenschap om op te geven of Azure Virtual 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 deze optie is ingesteld op uitgeschakeld, wordt al het verkeer met uitzondering van privé-eindpunten en verkeer dat afkomstig is van vertrouwde services, geblokkeerd. Hierdoor worden de ingestelde firewallregels overschreven, wat betekent dat zelfs als de firewallregels aanwezig zijn, we de regels niet respecteren.
sku	Sku		SKU-details
softDeleteRetentionInDays	integer	90	softDelete dagen voor gegevensretentie. Het accepteert >=7 en <=90.
tenantId	string		De Azure Active Directory-tenant-id die moet worden gebruikt voor het verifiëren van aanvragen voor de sleutelkluis.
vaultUri	string		De URI van de kluis voor het uitvoeren van bewerkingen op sleutels en geheimen.

VaultProvisioningState

Inrichtingsstatus van de kluis.

Name	Type	Description
RegisteringDns	string
Succeeded	string

VirtualNetworkRule

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

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.