Vaults - List

Service:

Key Vault

API Version:

2022-07-01

Åtgärden Lista hämtar information om de valv som är associerade med prenumerationen.

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-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string	Autentiseringsuppgifter för prenumeration som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
$filter	query	True	VaultListFilterTypes	Filtret som ska tillämpas på åtgärden.
api-version	query	True	ResourceManagerApiVersions	Azure Resource Manager API-version.
$top	query		integer int32	Maximalt antal resultat som ska returneras.

Svar

Name	Typ	Description
200 OK	ResourceListResult	Hämta information om alla nyckelvalv i prenumerationen.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Exempel

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

Definitioner

Name	Description
CloudError	Ett felsvar från Key Vault resursprovider
CloudErrorBody	Ett felsvar från Key Vault resursprovider
Resource	Key Vault resurs
ResourceListResult	Lista över valvresurser.
ResourceManagerApiVersions	Azure Resource Manager API-version.
VaultListFilterTypes	Filtret som ska tillämpas på åtgärden.

CloudError

Ett felsvar från Key Vault resursprovider

Name	Typ	Description
error	CloudErrorBody	Ett felsvar från Key Vault resursprovider

CloudErrorBody

Ett felsvar från Key Vault resursprovider

Name	Typ	Description
code	string	Felkod. Detta är en mnemonic som kan konsumeras programmatiskt.
message	string	Användarvänligt felmeddelande. Meddelandet är vanligtvis lokaliserat och kan variera beroende på tjänstversion.

Resource

Key Vault resurs

Name	Typ	Description
id	string	Fullständigt kvalificerad identifierare för nyckelvalvsresursen.
location	string	Azure-platsen för nyckelvalvsresursen.
name	string	Namnet på nyckelvalvsresursen.
tags	object	Taggar som tilldelats till nyckelvalvsresursen.
type	string	Resurstyp för nyckelvalvsresursen.

ResourceListResult

Lista över valvresurser.

Name	Typ	Description
nextLink	string	URL:en för att hämta nästa uppsättning valvresurser.
value	Resource[]	Listan över valvresurser.

ResourceManagerApiVersions

Azure Resource Manager API-version.

Name	Typ	Description
2015-11-01	string

VaultListFilterTypes

Filtret som ska tillämpas på åtgärden.

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