Vaults - List

Layanan:

Key Vault

Versi API:

2024-11-01

Operasi Daftar mendapatkan informasi tentang brankas yang terkait dengan langganan.

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

Dengan parameter opsional:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
$filter	query	True	VaultListFilterTypes	Filter yang akan diterapkan pada operasi.
api-version	query	True	ResourceManagerApiVersions	Versi API Azure Resource Manager.
$top	query		integer (int32)	Jumlah maksimum hasil yang akan dikembalikan.

Respons

Nama	Jenis	Deskripsi
200 OK	ResourceListResult	Dapatkan informasi tentang semua brankas kunci dalam langganan.
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

List vaults in the specified subscription

Permintaan sampel

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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
CloudError	Respons error dari penyedia resource Key Vault
CloudErrorBody	Respons error dari penyedia resource Key Vault
Resource	Sumber daya Key Vault
ResourceListResult	Daftar sumber daya brankas.
ResourceManagerApiVersions	Versi API Azure Resource Manager.
VaultListFilterTypes	Filter yang akan diterapkan pada operasi.

CloudError

Objek

Respons error dari penyedia resource Key Vault

Nama	Jenis	Deskripsi
error	CloudErrorBody	Respons error dari penyedia resource Key Vault

CloudErrorBody

Objek

Respons error dari penyedia resource Key Vault

Nama	Jenis	Deskripsi
code	string	Kode kesalahan. Ini adalah mnemonik yang dapat dikonsumsi secara terprogram.
message	string	Pesan kesalahan yang mudah digunakan. Pesan biasanya dilokalkan dan dapat bervariasi dengan versi layanan.

Resource

Objek

Sumber daya Key Vault

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya brankas kunci yang sepenuhnya memenuhi syarat.
location	string	Lokasi Azure sumber daya brankas kunci.
name	string	Nama sumber daya brankas kunci.
tags	object	Tag yang ditetapkan ke sumber daya brankas kunci.
type	string	Jenis sumber daya sumber daya brankas kunci.

ResourceListResult

Objek

Daftar sumber daya brankas.

Nama	Jenis	Deskripsi
nextLink	string	URL untuk mendapatkan kumpulan resource vault berikutnya.
value	Resource[]	Daftar sumber daya brankas.

ResourceManagerApiVersions

Enumerasi

Versi API Azure Resource Manager.

Nilai	Deskripsi
2015-11-01

VaultListFilterTypes

Enumerasi

Filter yang akan diterapkan pada operasi.

Nilai	Deskripsi
resourceType eq 'Microsoft.KeyVault/vaults'