Vaults - List

Service:

Key Vault

API Version:

2022-07-01

Met de lijstbewerking wordt informatie opgehaald over de kluizen die zijn gekoppeld aan het abonnement.

GET https://management.azure.com/subscriptions/{subscriptionId}/resources?$filter=resourceType eq 'Microsoft.KeyVault/vaults'&api-version=2015-11-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resources?$filter=resourceType eq 'Microsoft.KeyVault/vaults'&$top={$top}&api-version=2015-11-01

URI-parameters

Name	In	Vereist	Type	Description
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.
$filter	query	True	VaultListFilterTypes	Het filter dat moet worden toegepast op de bewerking.
api-version	query	True	ResourceManagerApiVersions	Api-versie van Azure Resource Manager.
$top	query		integer int32	Maximum aantal resultaten dat moet worden geretourneerd.

Antwoorden

Name	Type	Description
200 OK	ResourceListResult	Informatie ophalen over alle sleutelkluizen in het abonnement.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

List vaults in the specified subscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resources?$filter=resourceType eq 'Microsoft.KeyVault/vaults'&$top=1&api-version=2015-11-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.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()
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/listVault.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": {}
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resources?%24filter=resourceType+eq+%27Microsoft.KeyVault%2fvaults%27&%24top=4&api-version=2015-11-01&%24skiptoken=eyJuZXh0UGFydGl0aW9uS2V5IjoiMSE4IVEwTTJNVGMtIiwibmV4dFJvd0tleSI6IjEhMTMyIU5rUTRSVEU1UXpJelFUWXdORGd4UmpoRlFrSXhNVGhFUXpNd01EZEROVVJmVkVkT1RDMU5TVU5TVDFOUFJsUTZNa1ZMUlZsV1FWVk1WRG95UmxaQlZVeFVVeTFUVTFKSExVcEpUVG95UkZSRlUxUTZNa1JXUVZWTVZDMVhSVk5VVlZNLSJ9"
}

Definities

Name	Description
CloudError	Een foutbericht van Key Vault resourceprovider
CloudErrorBody	Een foutbericht van Key Vault resourceprovider
Resource	Key Vault resource
ResourceListResult	Lijst met kluisresources.
ResourceManagerApiVersions	Api-versie van Azure Resource Manager.
VaultListFilterTypes	Het filter dat moet worden toegepast op de bewerking.

CloudError

Een foutbericht van Key Vault resourceprovider

Name	Type	Description
error	CloudErrorBody	Een foutbericht van Key Vault resourceprovider

CloudErrorBody

Een foutbericht 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 variëren per serviceversie.

Resource

Key Vault resource

Name	Type	Description
id	string	Volledig gekwalificeerde id van de sleutelkluisresource.
location	string	Azure-locatie van de sleutelkluisresource.
name	string	Naam van de sleutelkluisresource.
tags	object	Tags die zijn toegewezen aan de sleutelkluisresource.
type	string	Resourcetype van de sleutelkluisresource.

ResourceListResult

Lijst met kluisresources.

Name	Type	Description
nextLink	string	De URL voor het ophalen van de volgende set kluisresources.
value	Resource[]	De lijst met kluisresources.

ResourceManagerApiVersions

Api-versie van Azure Resource Manager.

Name	Type	Description
2015-11-01	string

VaultListFilterTypes

Het filter dat moet worden toegepast op de bewerking.

Name	Type	Description
resourceType eq 'Microsoft.KeyVault/vaults'	string