Vaults - List By Resource Group

Odwołanie

Service:: Key Vault

API Version:: 2022-07-01

Operacja Lista pobiera informacje o magazynach skojarzonych z subskrypcją i w określonej grupie zasobów.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów, do której należy magazyn.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.
$top	query		integer int32	Maksymalna liczba wyników do zwrócenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	VaultListResult	Uzyskaj informacje o wszystkich magazynach kluczy w określonej grupie zasobów.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

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

Definicje

Nazwa	Opis
AccessPolicyEntry	Tożsamość, która ma dostęp do magazynu kluczy. Wszystkie tożsamości w tablicy muszą używać tego samego identyfikatora dzierżawy co identyfikator dzierżawy magazynu kluczy.
ActionsRequired	Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji u konsumenta.
CertificatePermissions	Uprawnienia do certyfikatów
CloudError	Odpowiedź o błędzie od dostawcy zasobów Key Vault
CloudErrorBody	Odpowiedź o błędzie od dostawcy zasobów Key Vault
CreateMode	Tryb tworzenia magazynu, aby wskazać, czy magazyn musi zostać odzyskany, czy nie.
identityType	Typ tożsamości, która utworzyła zasób magazynu kluczy.
IPRule	Reguła regulująca dostępność magazynu z określonego adresu IP lub zakresu adresów IP.
KeyPermissions	Uprawnienia do kluczy
NetworkRuleAction	Domyślna akcja, gdy żadna reguła z reguł ipRules i virtualNetworkRules jest zgodna. Jest to używane tylko po ocenie właściwości obejścia.
NetworkRuleBypassOptions	Informuje, jaki ruch może pomijać reguły sieci. Może to być wartość "AzureServices" lub "Brak". Jeśli nie określono wartości domyślnej to "AzureServices".
NetworkRuleSet	Zestaw reguł określających dostępność sieci magazynu.
Permissions	Uprawnienia tożsamości mają klucze, wpisy tajne, certyfikaty i magazyn.
PrivateEndpoint	Właściwości obiektu prywatnego punktu końcowego.
PrivateEndpointConnectionItem	Element połączenia prywatnego punktu końcowego.
PrivateEndpointConnectionProvisioningState	Bieżący stan aprowizacji.
PrivateEndpointServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego.
PrivateLinkServiceConnectionState	Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego.
SecretPermissions	Uprawnienia do wpisów tajnych
Sku	Szczegóły jednostki SKU
SkuFamily	Nazwa rodziny jednostek SKU
SkuName	Nazwa jednostki SKU określająca, czy magazyn kluczy jest magazynem w warstwie Standardowa, czy magazynem w warstwie Premium.
StoragePermissions	Uprawnienia do kont magazynu
SystemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu magazynu kluczy.
Vault	Informacje o zasobach z rozszerzonymi szczegółami.
VaultListResult	Lista magazynów
VaultProperties	Właściwości magazynu
VaultProvisioningState	Stan aprowizacji magazynu.
VirtualNetworkRule	Reguła regulująca dostępność magazynu z określonej sieci wirtualnej.

AccessPolicyEntry

Tożsamość, która ma dostęp do magazynu kluczy. Wszystkie tożsamości w tablicy muszą używać tego samego identyfikatora dzierżawy co identyfikator dzierżawy magazynu kluczy.

Nazwa	Typ	Opis
applicationId	string	Identyfikator aplikacji klienta wysyłającego żądanie w imieniu podmiotu zabezpieczeń
objectId	string	Identyfikator obiektu użytkownika, jednostki usługi lub grupy zabezpieczeń w dzierżawie usługi Azure Active Directory dla magazynu. Identyfikator obiektu musi być unikatowy dla listy zasad dostępu.
permissions	Permissions	Uprawnienia tożsamości mają klucze, wpisy tajne i certyfikaty.
tenantId	string	Identyfikator dzierżawy usługi Azure Active Directory, który powinien być używany do uwierzytelniania żądań do magazynu kluczy.

ActionsRequired

Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji u konsumenta.

Nazwa	Typ	Opis
None	string

CertificatePermissions

Uprawnienia do certyfikatów

Nazwa	Typ	Opis
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

Odpowiedź o błędzie od dostawcy zasobów Key Vault

Nazwa	Typ	Opis
error	CloudErrorBody	Odpowiedź o błędzie od dostawcy zasobów Key Vault

CloudErrorBody

Odpowiedź o błędzie od dostawcy zasobów Key Vault

Nazwa	Typ	Opis
code	string	Kod błędu. Jest to mnemonic, który może być używany programowo.
message	string	Przyjazny dla użytkownika komunikat o błędzie. Komunikat jest zazwyczaj zlokalizowany i może się różnić w zależności od wersji usługi.

CreateMode

Tryb tworzenia magazynu, aby wskazać, czy magazyn musi zostać odzyskany, czy nie.

Nazwa	Typ	Opis
default	string
recover	string

identityType

Typ tożsamości, która utworzyła zasób magazynu kluczy.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

IPRule

Reguła regulująca dostępność magazynu z określonego adresu IP lub zakresu adresów IP.

Nazwa	Typ	Opis
value	string	Zakres adresów IPv4 w notacji CIDR, taki jak "124.56.78.91" (prosty adres IP) lub "124.56.78.0/24" (wszystkie adresy rozpoczynające się od 124.56.78).

KeyPermissions

Uprawnienia do kluczy

Nazwa	Typ	Opis
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

Domyślna akcja, gdy żadna reguła z reguł ipRules i virtualNetworkRules jest zgodna. Jest to używane tylko po ocenie właściwości obejścia.

Nazwa	Typ	Opis
Allow	string
Deny	string

NetworkRuleBypassOptions

Informuje, jaki ruch może pomijać reguły sieci. Może to być wartość "AzureServices" lub "Brak". Jeśli nie określono wartości domyślnej to "AzureServices".

Nazwa	Typ	Opis
AzureServices	string
None	string

NetworkRuleSet

Zestaw reguł określających dostępność sieci magazynu.

Nazwa	Typ	Opis
bypass	NetworkRuleBypassOptions	Informuje, jaki ruch może pomijać reguły sieci. Może to być wartość "AzureServices" lub "Brak". Jeśli nie określono wartości domyślnej to "AzureServices".
defaultAction	NetworkRuleAction	Domyślna akcja, gdy żadna reguła z reguł ipRules i virtualNetworkRules jest zgodna. Jest to używane tylko po ocenie właściwości obejścia.
ipRules	IPRule[]	Lista reguł adresów IP.
virtualNetworkRules	VirtualNetworkRule[]	Lista reguł sieci wirtualnej.

Permissions

Uprawnienia tożsamości mają klucze, wpisy tajne, certyfikaty i magazyn.

Nazwa	Typ	Opis
certificates	CertificatePermissions[]	Uprawnienia do certyfikatów
keys	KeyPermissions[]	Uprawnienia do kluczy
secrets	SecretPermissions[]	Uprawnienia do wpisów tajnych
storage	StoragePermissions[]	Uprawnienia do kont magazynu

PrivateEndpoint

Właściwości obiektu prywatnego punktu końcowego.

Nazwa	Typ	Opis
id	string	Pełny identyfikator zasobu prywatnego punktu końcowego.

PrivateEndpointConnectionItem

Element połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
etag	string	Modyfikowane za każdym razem, gdy nastąpi zmiana stanu połączenia prywatnego punktu końcowego.
id	string	Identyfikator połączenia prywatnego punktu końcowego.
properties.privateEndpoint	PrivateEndpoint	Właściwości obiektu prywatnego punktu końcowego.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stan zatwierdzenia połączenia łącza prywatnego.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.

PrivateEndpointConnectionProvisioningState

Bieżący stan aprowizacji.

Nazwa	Typ	Opis
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego.

Nazwa	Typ	Opis
actionsRequired	ActionsRequired	Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji u konsumenta.
description	string	Przyczyna zatwierdzenia lub odrzucenia.
status	PrivateEndpointServiceConnectionStatus	Wskazuje, czy połączenie zostało zatwierdzone, odrzucone lub usunięte przez właściciela magazynu kluczy.

SecretPermissions

Uprawnienia do wpisów tajnych

Nazwa	Typ	Opis
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	string

Sku

Szczegóły jednostki SKU

Nazwa	Typ	Opis
family	SkuFamily	Nazwa rodziny jednostek SKU
name	SkuName	Nazwa jednostki SKU określająca, czy magazyn kluczy jest magazynem w warstwie Standardowa, czy magazynem w warstwie Premium.

SkuFamily

Nazwa rodziny jednostek SKU

Nazwa	Typ	Opis
A	string

SkuName

Nazwa jednostki SKU określająca, czy magazyn kluczy jest magazynem w warstwie Standardowa, czy magazynem w warstwie Premium.

Nazwa	Typ	Opis
premium	string
standard	string

StoragePermissions

Uprawnienia do kont magazynu

Nazwa	Typ	Opis
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

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu magazynu kluczy.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów magazynu kluczy (UTC).
createdBy	string	Tożsamość, która utworzyła zasób magazynu kluczy.
createdByType	identityType	Typ tożsamości, która utworzyła zasób magazynu kluczy.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu magazynu kluczy (UTC).
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób magazynu kluczy.
lastModifiedByType	identityType	Typ tożsamości, która ostatnio zmodyfikowała zasób magazynu kluczy.

Vault

Informacje o zasobach z rozszerzonymi szczegółami.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu magazynu kluczy.
location	string	Lokalizacja platformy Azure zasobu magazynu kluczy.
name	string	Nazwa zasobu magazynu kluczy.
properties	VaultProperties	Właściwości magazynu
systemData	SystemData	Metadane systemowe magazynu kluczy.
tags	object	Tagi przypisane do zasobu magazynu kluczy.
type	string	Typ zasobu magazynu kluczy.

VaultListResult

Lista magazynów

Nazwa	Typ	Opis
nextLink	string	Adres URL umożliwiający pobranie następnego zestawu magazynów.
value	Vault[]	Lista magazynów.

VaultProperties

Właściwości magazynu

Nazwa	Typ	Wartość domyślna	Opis
accessPolicies	AccessPolicyEntry[]		Tablica od 0 do 1024 tożsamości, które mają dostęp do magazynu kluczy. Wszystkie tożsamości w tablicy muszą używać tego samego identyfikatora dzierżawy co identyfikator dzierżawy magazynu kluczy. Jeśli `createMode` jest ustawiona wartość `recover`, zasady dostępu nie są wymagane. W przeciwnym razie wymagane są zasady dostępu.
createMode	CreateMode		Tryb tworzenia magazynu, aby wskazać, czy magazyn musi zostać odzyskany, czy nie.
enablePurgeProtection	boolean		Właściwość określająca, czy dla tego magazynu jest włączona ochrona przed przeczyszczeniem. Ustawienie tej właściwości na wartość true powoduje aktywowanie ochrony przed przeczyszczeniem tego magazynu i jego zawartości — tylko usługa Key Vault może zainicjować twarde, nieodwracalne usunięcie. To ustawienie jest skuteczne tylko w przypadku włączenia usuwania nietrwałego. Włączenie tej funkcji jest nieodwracalne — czyli właściwość nie akceptuje wartości false jako jej wartości.
enableRbacAuthorization	boolean	False	Właściwość, która kontroluje sposób autoryzacji akcji danych. W przypadku wartości true magazyn kluczy będzie używać Access Control opartych na rolach (RBAC) do autoryzacji akcji danych, a zasady dostępu określone we właściwościach magazynu zostaną zignorowane. W przypadku wartości false magazyn kluczy będzie używać zasad dostępu określonych we właściwościach magazynu, a wszystkie zasady przechowywane w usłudze Azure Resource Manager zostaną zignorowane. Jeśli wartość null lub nie zostanie określona, magazyn zostanie utworzony z wartością domyślną false. Należy pamiętać, że akcje zarządzania są zawsze autoryzowane przy użyciu kontroli dostępu opartej na rolach.
enableSoftDelete	boolean	True	Właściwość określająca, czy dla tego magazynu kluczy włączono funkcję usuwania nietrwałego. Jeśli podczas tworzenia nowego magazynu kluczy nie zostanie ustawiona żadna wartość (prawda lub fałsz), zostanie ona domyślnie ustawiona na wartość true. Po ustawieniu wartości true nie można przywrócić wartości false.
enabledForDeployment	boolean		Właściwość określająca, czy usługa Azure Virtual Machines może pobierać certyfikaty przechowywane jako wpisy tajne z magazynu kluczy.
enabledForDiskEncryption	boolean		Właściwość określająca, czy usługa Azure Disk Encryption może pobierać wpisy tajne z magazynu i odpakowywać klucze.
enabledForTemplateDeployment	boolean		Właściwość określająca, czy usługa Azure Resource Manager może pobierać wpisy tajne z magazynu kluczy.
hsmPoolResourceId	string		Identyfikator zasobu puli HSM.
networkAcls	NetworkRuleSet		Reguły rządzące ułatwieniami dostępu magazynu kluczy z określonych lokalizacji sieciowych.
privateEndpointConnections	PrivateEndpointConnectionItem[]		Lista połączeń prywatnych punktów końcowych skojarzonych z magazynem kluczy.
provisioningState	VaultProvisioningState		Stan aprowizacji magazynu.
publicNetworkAccess	string	enabled	Właściwość określająca, czy magazyn będzie akceptować ruch z publicznego Internetu. W przypadku ustawienia opcji "disabled" cały ruch z wyjątkiem ruchu prywatnego punktu końcowego i pochodzącego z zaufanych usług zostanie zablokowany. Spowoduje to zastąpienie ustawionych reguł zapory, co oznacza, że nawet jeśli reguły zapory są obecne, nie będziemy przestrzegać reguł.
sku	Sku		Szczegóły jednostki SKU
softDeleteRetentionInDays	integer	90	softDelete data retention days (dni przechowywania danych softDelete). Akceptuje >=7 i <=90.
tenantId	string		Identyfikator dzierżawy usługi Azure Active Directory, który powinien być używany do uwierzytelniania żądań do magazynu kluczy.
vaultUri	string		Identyfikator URI magazynu do wykonywania operacji na kluczach i wpisach tajnych.

VaultProvisioningState

Stan aprowizacji magazynu.

Nazwa	Typ	Opis
RegisteringDns	string
Succeeded	string

VirtualNetworkRule

Reguła regulująca dostępność magazynu z określonej sieci wirtualnej.

Nazwa	Typ	Opis
id	string	Pełny identyfikator zasobu podsieci sieci wirtualnej, taki jak "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".
ignoreMissingVnetServiceEndpoint	boolean	Właściwość określająca, czy dostawca nrP zignoruje sprawdzanie, czy podsieć nadrzędna ma skonfigurowane punkty serviceEndpoint.