Vaults - List By Resource Group

Referensi

Service:: Key Vault

API Version:: 2022-07-01

Operasi Daftar mendapatkan informasi tentang vault yang terkait dengan langganan dan dalam grup sumber daya yang ditentukan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama Grup Sumber Daya tempat vault berada.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi Api Klien.
$top	query		integer int32	Jumlah hasil maksimum yang akan dikembalikan.

Respons

Nama	Jenis	Deskripsi
200 OK	VaultListResult	Dapatkan informasi tentang semua brankas kunci dalam grup sumber daya yang ditentukan.
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

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

Definisi

Nama	Deskripsi
AccessPolicyEntry	Identitas yang memiliki akses ke brankas kunci. Semua identitas dalam array harus menggunakan ID penyewa yang sama dengan ID penyewa brankas kunci.
ActionsRequired	Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.
CertificatePermissions	Izin ke sertifikat
CloudError	Respons kesalahan dari penyedia sumber daya Key Vault
CloudErrorBody	Respons kesalahan dari penyedia sumber daya Key Vault
CreateMode	Mode buat vault untuk menunjukkan apakah vault perlu dipulihkan atau tidak.
identityType	Jenis identitas yang membuat sumber daya brankas kunci.
IPRule	Aturan yang mengatur aksesibilitas vault dari alamat IP atau rentang ip tertentu.
KeyPermissions	Izin ke kunci
NetworkRuleAction	Tindakan default ketika tidak ada aturan dari ipRules dan dari virtualNetworkRules yang cocok. Ini hanya digunakan setelah properti bypass dievaluasi.
NetworkRuleBypassOptions	Memberi tahu lalu lintas apa yang dapat melewati aturan jaringan. Ini bisa menjadi 'AzureServices' atau 'None'. Jika tidak ditentukan, defaultnya adalah 'AzureServices'.
NetworkRuleSet	Seperangkat aturan yang mengatur aksesibilitas jaringan vault.
Permissions	Izin yang dimiliki identitas untuk kunci, rahasia, sertifikat, dan penyimpanan.
PrivateEndpoint	Properti objek titik akhir privat.
PrivateEndpointConnectionItem	Item koneksi titik akhir privat.
PrivateEndpointConnectionProvisioningState	Status penyediaan saat ini.
PrivateEndpointServiceConnectionStatus	Status koneksi titik akhir privat.
PrivateLinkServiceConnectionState	Objek yang mewakili status persetujuan koneksi tautan privat.
SecretPermissions	Izin ke rahasia
Sku	Detail SKU
SkuFamily	Nama keluarga SKU
SkuName	Nama SKU untuk menentukan apakah brankas kunci adalah vault standar atau vault premium.
StoragePermissions	Izin ke akun penyimpanan
SystemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya brankas kunci.
Vault	Informasi sumber daya dengan detail yang diperluas.
VaultListResult	Daftar vault
VaultProperties	Properti vault
VaultProvisioningState	Status penyediaan vault.
VirtualNetworkRule	Aturan yang mengatur aksesibilitas vault dari jaringan virtual tertentu.

AccessPolicyEntry

Identitas yang memiliki akses ke brankas kunci. Semua identitas dalam array harus menggunakan ID penyewa yang sama dengan ID penyewa brankas kunci.

Nama	Jenis	Deskripsi
applicationId	string	ID aplikasi klien yang membuat permintaan atas nama prinsipal
objectId	string	ID objek pengguna, perwakilan layanan, atau grup keamanan di penyewa Azure Active Directory untuk vault. ID objek harus unik untuk daftar kebijakan akses.
permissions	Permissions	Izin yang dimiliki identitas untuk kunci, rahasia, dan sertifikat.
tenantId	string	ID penyewa Azure Active Directory yang harus digunakan untuk mengautentikasi permintaan ke brankas kunci.

ActionsRequired

Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.

Nama	Jenis	Deskripsi
None	string

CertificatePermissions

Izin ke sertifikat

Nama	Jenis	Deskripsi
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

Respons kesalahan dari penyedia sumber daya Key Vault

Nama	Jenis	Deskripsi
error	CloudErrorBody	Respons kesalahan dari penyedia sumber daya Key Vault

CloudErrorBody

Respons kesalahan dari penyedia sumber daya 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 menurut versi layanan.

CreateMode

Mode buat vault untuk menunjukkan apakah vault perlu dipulihkan atau tidak.

Nama	Jenis	Deskripsi
default	string
recover	string

identityType

Jenis identitas yang membuat sumber daya brankas kunci.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

IPRule

Aturan yang mengatur aksesibilitas vault dari alamat IP atau rentang ip tertentu.

Nama	Jenis	Deskripsi
value	string	Rentang alamat IPv4 dalam notasi CIDR, seperti '124.56.78.91' (alamat IP sederhana) atau '124.56.78.0/24' (semua alamat yang dimulai dengan 124.56.78).

KeyPermissions

Izin ke kunci

Nama	Jenis	Deskripsi
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

Tindakan default ketika tidak ada aturan dari ipRules dan dari virtualNetworkRules yang cocok. Ini hanya digunakan setelah properti bypass dievaluasi.

Nama	Jenis	Deskripsi
Allow	string
Deny	string

NetworkRuleBypassOptions

Memberi tahu lalu lintas apa yang dapat melewati aturan jaringan. Ini bisa menjadi 'AzureServices' atau 'None'. Jika tidak ditentukan, defaultnya adalah 'AzureServices'.

Nama	Jenis	Deskripsi
AzureServices	string
None	string

NetworkRuleSet

Seperangkat aturan yang mengatur aksesibilitas jaringan vault.

Nama	Jenis	Deskripsi
bypass	NetworkRuleBypassOptions	Memberi tahu lalu lintas apa yang dapat melewati aturan jaringan. Ini bisa menjadi 'AzureServices' atau 'None'. Jika tidak ditentukan, defaultnya adalah 'AzureServices'.
defaultAction	NetworkRuleAction	Tindakan default ketika tidak ada aturan dari ipRules dan dari virtualNetworkRules yang cocok. Ini hanya digunakan setelah properti bypass dievaluasi.
ipRules	IPRule[]	Daftar aturan alamat IP.
virtualNetworkRules	VirtualNetworkRule[]	Daftar aturan jaringan virtual.

Permissions

Izin yang dimiliki identitas untuk kunci, rahasia, sertifikat, dan penyimpanan.

Nama	Jenis	Deskripsi
certificates	CertificatePermissions[]	Izin ke sertifikat
keys	KeyPermissions[]	Izin ke kunci
secrets	SecretPermissions[]	Izin ke rahasia
storage	StoragePermissions[]	Izin ke akun penyimpanan

PrivateEndpoint

Properti objek titik akhir privat.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi lengkap sumber daya titik akhir privat.

PrivateEndpointConnectionItem

Item koneksi titik akhir privat.

Nama	Jenis	Deskripsi
etag	string	Dimodifikasi setiap kali ada perubahan status koneksi titik akhir privat.
id	string	Id koneksi titik akhir privat.
properties.privateEndpoint	PrivateEndpoint	Properti objek titik akhir privat.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Status persetujuan koneksi tautan privat.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Status penyediaan koneksi titik akhir privat.

PrivateEndpointConnectionProvisioningState

Status penyediaan saat ini.

Nama	Jenis	Deskripsi
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Status koneksi titik akhir privat.

Nama	Jenis	Deskripsi
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Objek yang mewakili status persetujuan koneksi tautan privat.

Nama	Jenis	Deskripsi
actionsRequired	ActionsRequired	Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.
description	string	Alasan persetujuan atau penolakan.
status	PrivateEndpointServiceConnectionStatus	Menunjukkan apakah koneksi telah disetujui, ditolak, atau dihapus oleh pemilik brankas kunci.

SecretPermissions

Izin ke rahasia

Nama	Jenis	Deskripsi
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	string

Sku

Detail SKU

Nama	Jenis	Deskripsi
family	SkuFamily	Nama keluarga SKU
name	SkuName	Nama SKU untuk menentukan apakah brankas kunci adalah vault standar atau vault premium.

SkuFamily

Nama keluarga SKU

Nama	Jenis	Deskripsi
A	string

SkuName

Nama SKU untuk menentukan apakah brankas kunci adalah vault standar atau vault premium.

Nama	Jenis	Deskripsi
premium	string
standard	string

StoragePermissions

Izin ke akun penyimpanan

Nama	Jenis	Deskripsi
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

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya brankas kunci.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya brankas kunci (UTC).
createdBy	string	Identitas yang membuat sumber daya brankas kunci.
createdByType	identityType	Jenis identitas yang membuat sumber daya brankas kunci.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya brankas kunci (UTC).
lastModifiedBy	string	Identitas yang terakhir memodifikasi sumber daya brankas kunci.
lastModifiedByType	identityType	Jenis identitas yang terakhir memodifikasi sumber daya brankas kunci.

Vault

Informasi sumber daya dengan detail yang diperluas.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya brankas kunci yang sepenuhnya memenuhi syarat.
location	string	Lokasi Azure dari sumber daya brankas kunci.
name	string	Nama sumber daya brankas kunci.
properties	VaultProperties	Properti vault
systemData	SystemData	Metadata sistem untuk brankas kunci.
tags	object	Tag yang ditetapkan ke sumber daya brankas kunci.
type	string	Jenis sumber daya sumber daya brankas kunci.

VaultListResult

Daftar vault

Nama	Jenis	Deskripsi
nextLink	string	URL untuk mendapatkan set vault berikutnya.
value	Vault[]	Daftar vault.

VaultProperties

Properti vault

Nama	Jenis	Nilai Default	Deskripsi
accessPolicies	AccessPolicyEntry[]		Array identitas 0 hingga 1024 yang memiliki akses ke brankas kunci. Semua identitas dalam array harus menggunakan ID penyewa yang sama dengan ID penyewa brankas kunci. Ketika `createMode` diatur ke `recover`, kebijakan akses tidak diperlukan. Jika tidak, kebijakan akses diperlukan.
createMode	CreateMode		Mode buat vault untuk menunjukkan apakah vault perlu dipulihkan atau tidak.
enablePurgeProtection	boolean		Properti yang menentukan apakah perlindungan terhadap penghapusan menyeluruh diaktifkan untuk vault ini. Mengatur properti ini ke true akan mengaktifkan perlindungan terhadap penghapusan menyeluruh untuk brankas ini dan kontennya - hanya layanan Key Vault yang dapat memulai penghapusan yang sulit dan tidak dapat dipulihkan. Pengaturan ini hanya efektif jika penghapusan sementara juga diaktifkan. Mengaktifkan fungsionalitas ini tidak dapat diubah - yaitu, properti tidak menerima false sebagai nilainya.
enableRbacAuthorization	boolean	False	Properti yang mengontrol bagaimana tindakan data diotorisasi. Jika true, brankas kunci akan menggunakan Access Control Berbasis Peran (RBAC) untuk otorisasi tindakan data, dan kebijakan akses yang ditentukan dalam properti vault akan diabaikan. Ketika false, brankas kunci akan menggunakan kebijakan akses yang ditentukan dalam properti brankas, dan kebijakan apa pun yang disimpan di Azure Resource Manager akan diabaikan. Jika null atau tidak ditentukan, vault dibuat dengan nilai default false. Perhatikan bahwa tindakan manajemen selalu diotorisasi dengan RBAC.
enableSoftDelete	boolean	True	Properti untuk menentukan apakah fungsionalitas 'penghapusan sementara' diaktifkan untuk brankas kunci ini. Jika tidak diatur ke nilai apa pun (benar atau salah) saat membuat brankas kunci baru, nilai tersebut akan diatur ke true secara default. Setelah diatur ke true, tidak dapat dikembalikan ke false.
enabledForDeployment	boolean		Properti untuk menentukan apakah Azure Virtual Machines diizinkan untuk mengambil sertifikat yang disimpan sebagai rahasia dari brankas kunci.
enabledForDiskEncryption	boolean		Properti untuk menentukan apakah Azure Disk Encryption diizinkan untuk mengambil rahasia dari brankas dan membongkar kunci.
enabledForTemplateDeployment	boolean		Properti untuk menentukan apakah Azure Resource Manager diizinkan untuk mengambil rahasia dari brankas kunci.
hsmPoolResourceId	string		Id sumber daya Kumpulan HSM.
networkAcls	NetworkRuleSet		Aturan yang mengatur aksesibilitas brankas kunci dari lokasi jaringan tertentu.
privateEndpointConnections	PrivateEndpointConnectionItem[]		Daftar koneksi titik akhir privat yang terkait dengan brankas kunci.
provisioningState	VaultProvisioningState		Status penyediaan vault.
publicNetworkAccess	string	enabled	Properti untuk menentukan apakah vault akan menerima lalu lintas dari internet publik. Jika diatur ke 'dinonaktifkan' semua lalu lintas kecuali lalu lintas titik akhir privat dan yang berasal dari layanan tepercaya akan diblokir. Ini akan mengesampingkan aturan firewall yang ditetapkan, yang berarti bahwa bahkan jika aturan firewall ada, kami tidak akan mematuhi aturan.
sku	Sku		Detail SKU
softDeleteRetentionInDays	integer	90	softDelete hari retensi data. Ini menerima >=7 dan <=90.
tenantId	string		ID penyewa Azure Active Directory yang harus digunakan untuk mengautentikasi permintaan ke brankas kunci.
vaultUri	string		URI vault untuk melakukan operasi pada kunci dan rahasia.

VaultProvisioningState

Status penyediaan vault.

Nama	Jenis	Deskripsi
RegisteringDns	string
Succeeded	string

VirtualNetworkRule

Aturan yang mengatur aksesibilitas vault dari jaringan virtual tertentu.

Nama	Jenis	Deskripsi
id	string	Id sumber daya lengkap subnet vnet, seperti '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.
ignoreMissingVnetServiceEndpoint	boolean	Properti untuk menentukan apakah NRP akan mengabaikan pemeriksaan apakah subnet induk memiliki serviceEndpoints yang dikonfigurasi.