Vaults - List By Subscription

Referens

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}/providers/Microsoft.KeyVault/vaults?api-version=2022-07-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/vaults?$top={$top}&api-version=2022-07-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string	Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.
$top	query		integer int32	Maximalt antal resultat som ska returneras.

Svar

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

Exempel

List vaults in the specified subscription

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/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_subscription.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_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/listVaultBySubscription.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/resources?api-version=22022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

Definitioner

Name	Description
AccessPolicyEntry	En identitet som har åtkomst till nyckelvalvet. Alla identiteter i matrisen måste använda samma klient-ID som nyckelvalvets klient-ID.
ActionsRequired	Ett meddelande som anger om ändringar på tjänstleverantören kräver uppdateringar på konsumenten.
CertificatePermissions	Behörigheter till certifikat
CloudError	Ett felsvar från Key Vault resursprovider
CloudErrorBody	Ett felsvar från Key Vault resursprovider
CreateMode	Valvets skapandeläge för att ange om valvet behöver återställas eller inte.
identityType	Den typ av identitet som skapade nyckelvalvsresursen.
IPRule	En regel som styr tillgängligheten för ett valv från en specifik IP-adress eller ett ip-intervall.
KeyPermissions	Behörigheter till nycklar
NetworkRuleAction	Standardåtgärden när ingen regel från ipRules och virtualNetworkRules matchar. Detta används endast när egenskapen bypass har utvärderats.
NetworkRuleBypassOptions	Talar om för vilken trafik som kan kringgå nätverksregler. Detta kan vara "AzureServices" eller "None". Om det inte anges är standardvärdet "AzureServices".
NetworkRuleSet	En uppsättning regler som styr nätverkets tillgänglighet för ett valv.
Permissions	Behörigheter som identiteten har för nycklar, hemligheter, certifikat och lagring.
PrivateEndpoint	Egenskaper för privata slutpunktsobjekt.
PrivateEndpointConnectionItem	Anslutningsobjekt för privat slutpunkt.
PrivateEndpointConnectionProvisioningState	Det aktuella etableringstillståndet.
PrivateEndpointServiceConnectionStatus	Anslutningsstatus för privat slutpunkt.
PrivateLinkServiceConnectionState	Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.
SecretPermissions	Behörigheter till hemligheter
Sku	SKU-information
SkuFamily	SKU-familjenamn
SkuName	SKU-namn för att ange om nyckelvalvet är ett standardvalv eller ett Premium-valv.
StoragePermissions	Behörigheter till lagringskonton
SystemData	Metadata som rör skapande och senaste ändring av nyckelvalvsresursen.
Vault	Resursinformation med utökad information.
VaultListResult	Lista över valv
VaultProperties	Egenskaper för valvet
VaultProvisioningState	Etableringstillstånd för valvet.
VirtualNetworkRule	En regel som styr tillgängligheten för ett valv från ett specifikt virtuellt nätverk.

AccessPolicyEntry

En identitet som har åtkomst till nyckelvalvet. Alla identiteter i matrisen måste använda samma klient-ID som nyckelvalvets klient-ID.

Name	Typ	Description
applicationId	string	Program-ID för klienten som begär för ett huvudnamn
objectId	string	Objekt-ID för en användare, tjänstens huvudnamn eller säkerhetsgrupp i Azure Active Directory-klientorganisationen för valvet. Objekt-ID:t måste vara unikt för listan över åtkomstprinciper.
permissions	Permissions	Behörigheter som identiteten har för nycklar, hemligheter och certifikat.
tenantId	string	Azure Active Directory-klient-ID:t som ska användas för att autentisera begäranden till nyckelvalvet.

ActionsRequired

Ett meddelande som anger om ändringar på tjänstleverantören kräver uppdateringar på konsumenten.

Name	Typ	Description
None	string

CertificatePermissions

Behörigheter till certifikat

Name	Typ	Description
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

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 användas programmatiskt.
message	string	Användarvänligt felmeddelande. Meddelandet är vanligtvis lokaliserat och kan variera beroende på tjänstversion.

CreateMode

Valvets skapandeläge för att ange om valvet behöver återställas eller inte.

Name	Typ	Description
default	string
recover	string

identityType

Den typ av identitet som skapade nyckelvalvsresursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

IPRule

En regel som styr tillgängligheten för ett valv från en specifik IP-adress eller ett ip-intervall.

Name	Typ	Description
value	string	Ett IPv4-adressintervall i CIDR-notation, till exempel "124.56.78.91" (enkel IP-adress) eller "124.56.78.0/24" (alla adresser som börjar med 124.56.78).

KeyPermissions

Behörigheter till nycklar

Name	Typ	Description
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

Standardåtgärden när ingen regel från ipRules och virtualNetworkRules matchar. Detta används endast när egenskapen bypass har utvärderats.

Name	Typ	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

Talar om för vilken trafik som kan kringgå nätverksregler. Detta kan vara "AzureServices" eller "None". Om det inte anges är standardvärdet "AzureServices".

Name	Typ	Description
AzureServices	string
None	string

NetworkRuleSet

En uppsättning regler som styr nätverkets tillgänglighet för ett valv.

Name	Typ	Description
bypass	NetworkRuleBypassOptions	Talar om för vilken trafik som kan kringgå nätverksregler. Detta kan vara "AzureServices" eller "None". Om det inte anges är standardvärdet "AzureServices".
defaultAction	NetworkRuleAction	Standardåtgärden när ingen regel från ipRules och virtualNetworkRules matchar. Detta används endast när egenskapen bypass har utvärderats.
ipRules	IPRule[]	Listan över IP-adressregler.
virtualNetworkRules	VirtualNetworkRule[]	Listan över regler för virtuella nätverk.

Permissions

Behörigheter som identiteten har för nycklar, hemligheter, certifikat och lagring.

Name	Typ	Description
certificates	CertificatePermissions[]	Behörigheter till certifikat
keys	KeyPermissions[]	Behörigheter till nycklar
secrets	SecretPermissions[]	Behörigheter till hemligheter
storage	StoragePermissions[]	Behörigheter till lagringskonton

PrivateEndpoint

Egenskaper för privata slutpunktsobjekt.

Name	Typ	Description
id	string	Fullständig identifierare för den privata slutpunktsresursen.

PrivateEndpointConnectionItem

Anslutningsobjekt för privat slutpunkt.

Name	Typ	Description
etag	string	Ändras när det sker en ändring i tillståndet för den privata slutpunktsanslutningen.
id	string	ID för privat slutpunktsanslutning.
properties.privateEndpoint	PrivateEndpoint	Egenskaper för det privata slutpunktsobjektet.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Godkännandetillstånd för den privata länkanslutningen.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.

PrivateEndpointConnectionProvisioningState

Det aktuella etableringstillståndet.

Name	Typ	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.

Name	Typ	Description
actionsRequired	ActionsRequired	Ett meddelande som anger om ändringar på tjänstleverantören kräver uppdateringar på konsumenten.
description	string	Anledningen till godkännande eller avvisande.
status	PrivateEndpointServiceConnectionStatus	Anger om anslutningen har godkänts, avvisats eller tagits bort av nyckelvalvets ägare.

SecretPermissions

Behörigheter till hemligheter

Name	Typ	Description
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	string

Sku

SKU-information

Name	Typ	Description
family	SkuFamily	SKU-familjenamn
name	SkuName	SKU-namn för att ange om nyckelvalvet är ett standardvalv eller ett Premium-valv.

SkuFamily

SKU-familjenamn

Name	Typ	Description
A	string

SkuName

SKU-namn för att ange om nyckelvalvet är ett standardvalv eller ett Premium-valv.

Name	Typ	Description
premium	string
standard	string

StoragePermissions

Behörigheter till lagringskonton

Name	Typ	Description
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 som rör skapande och senaste ändring av nyckelvalvsresursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för skapandet av nyckelvalvets resurs (UTC).
createdBy	string	Identiteten som skapade nyckelvalvsresursen.
createdByType	identityType	Den typ av identitet som skapade nyckelvalvsresursen.
lastModifiedAt	string	Tidsstämpeln för nyckelvalvsresursens senaste ändring (UTC).
lastModifiedBy	string	Identiteten som senast ändrade nyckelvalvsresursen.
lastModifiedByType	identityType	Den typ av identitet som senast ändrade nyckelvalvsresursen.

Vault

Resursinformation med utökad information.

Name	Typ	Description
id	string	Fullständigt kvalificerad identifierare för nyckelvalvsresursen.
location	string	Azure-platsen för nyckelvalvsresursen.
name	string	Namnet på nyckelvalvsresursen.
properties	VaultProperties	Egenskaper för valvet
systemData	SystemData	Systemmetadata för nyckelvalvet.
tags	object	Taggar som tilldelats till nyckelvalvsresursen.
type	string	Resurstyp för nyckelvalvsresursen.

VaultListResult

Lista över valv

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

VaultProperties

Egenskaper för valvet

Name	Typ	Standardvärde	Description
accessPolicies	AccessPolicyEntry[]		En matris med 0 till 1 024 identiteter som har åtkomst till nyckelvalvet. Alla identiteter i matrisen måste använda samma klient-ID som nyckelvalvets klient-ID. När `createMode` är inställt på `recover`krävs inte åtkomstprinciper. Annars krävs åtkomstprinciper.
createMode	CreateMode		Valvets skapandeläge för att ange om valvet behöver återställas eller inte.
enablePurgeProtection	boolean		Egenskap som anger om skydd mot rensning är aktiverat för det här valvet. Om du ställer in den här egenskapen på true aktiveras skydd mot rensning för det här valvet och dess innehåll – endast Key Vault-tjänsten kan initiera en hård, oåterkallelig borttagning. Inställningen gäller endast om mjuk borttagning också är aktiverat. Det går inte att ångra aktiveringen av den här funktionen. Egenskapen accepterar inte false som värde.
enableRbacAuthorization	boolean	False	Egenskap som styr hur dataåtgärder auktoriseras. När det är sant använder nyckelvalvet rollbaserad Access Control (RBAC) för auktorisering av dataåtgärder, och åtkomstprinciperna som anges i valvegenskaper ignoreras. När det är falskt använder nyckelvalvet de åtkomstprinciper som anges i valvegenskaper, och alla principer som lagras i Azure Resource Manager ignoreras. Om null eller inte anges skapas valvet med standardvärdet false. Observera att hanteringsåtgärder alltid är auktoriserade med RBAC.
enableSoftDelete	boolean	True	Egenskap för att ange om funktionen "mjuk borttagning" är aktiverad för det här nyckelvalvet. Om det inte är inställt på något värde (sant eller falskt) när du skapar ett nytt nyckelvalv anges det till sant som standard. När värdet är sant kan det inte återställas till falskt.
enabledForDeployment	boolean		Egenskap för att ange om Azure Virtual Machines tillåts hämta certifikat som lagras som hemligheter från nyckelvalvet.
enabledForDiskEncryption	boolean		Egenskap för att ange om Azure Disk Encryption tillåts hämta hemligheter från valvet och packa upp nycklar.
enabledForTemplateDeployment	boolean		Egenskap som anger om Azure Resource Manager tillåts hämta hemligheter från nyckelvalvet.
hsmPoolResourceId	string		Resurs-ID för HSM-pool.
networkAcls	NetworkRuleSet		Regler som styr åtkomsten till nyckelvalvet från specifika nätverksplatser.
privateEndpointConnections	PrivateEndpointConnectionItem[]		Lista över privata slutpunktsanslutningar som är associerade med nyckelvalvet.
provisioningState	VaultProvisioningState		Etableringstillstånd för valvet.
publicNetworkAccess	string	enabled	Egenskap för att ange om valvet ska acceptera trafik från offentligt Internet. Om den är inställd på "inaktiverad" blockeras all trafik utom privat slutpunktstrafik och den som kommer från betrodda tjänster. Detta åsidosätter de angivna brandväggsreglerna, vilket innebär att även om brandväggsreglerna finns kommer vi inte att respektera reglerna.
sku	Sku		SKU-information
softDeleteRetentionInDays	integer	90	softTa bort datakvarhållningsdagar. Den accepterar >=7 och <=90.
tenantId	string		Azure Active Directory-klient-ID:t som ska användas för att autentisera begäranden till nyckelvalvet.
vaultUri	string		URI för valvet för att utföra åtgärder på nycklar och hemligheter.

VaultProvisioningState

Etableringstillstånd för valvet.

Name	Typ	Description
RegisteringDns	string
Succeeded	string

VirtualNetworkRule

En regel som styr tillgängligheten för ett valv från ett specifikt virtuellt nätverk.

Name	Typ	Description
id	string	Fullständigt resurs-ID för ett vnet-undernät, till exempel "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".
ignoreMissingVnetServiceEndpoint	boolean	Egenskap för att ange om NRP ska ignorera kontrollen om det överordnade undernätet har serviceEndpoints konfigurerade.