Vaults - Get

Riferimento

Service:: Key Vault

API Version:: 2022-07-01

Ottiene l'insieme di credenziali delle chiavi di Azure specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse a cui appartiene l'insieme di credenziali.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
vaultName	path	True	string	Nome dell'insieme di credenziali.
api-version	query	True	string	Versione api client.

Risposte

Nome	Tipo	Descrizione
200 OK	Vault	Insieme di credenziali recuperato
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

Retrieve a vault

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault?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 get_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.get(
        resource_group_name="sample-resource-group",
        vault_name="sample-vault",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/getVault.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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-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": "standard"
    },
    "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,
    "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
    "vaultUri": "https://sample-vault.vault.azure.net",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled"
  }
}

Definizioni

Nome	Descrizione
AccessPolicyEntry	Identità che ha accesso all'insieme di credenziali delle chiavi. Tutte le identità nella matrice devono usare lo stesso ID tenant dell'ID tenant dell'insieme di credenziali delle chiavi.
ActionsRequired	Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer.
CertificatePermissions	Autorizzazioni per i certificati
CloudError	Risposta di errore da Key Vault provider di risorse
CloudErrorBody	Risposta di errore da Key Vault provider di risorse
CreateMode	Modalità di creazione dell'insieme di credenziali per indicare se l'insieme di credenziali deve essere recuperato o meno.
identityType	Tipo di identità che ha creato la risorsa dell'insieme di credenziali delle chiavi.
IPRule	Regola che regola l'accessibilità di un insieme di credenziali da un indirizzo IP o un intervallo ip specifico.
KeyPermissions	Autorizzazioni per le chiavi
NetworkRuleAction	Azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrisponde. Questa opzione viene utilizzata solo dopo la valutazione della proprietà bypass.
NetworkRuleBypassOptions	Indica il traffico che può ignorare le regole di rete. Può trattarsi di 'AzureServices' o 'None'. Se non è specificato, il valore predefinito è "AzureServices".
NetworkRuleSet	Set di regole che regolano l'accessibilità di rete di un insieme di credenziali.
Permissions	Autorizzazioni per l'identità per chiavi, segreti, certificati e archiviazione.
PrivateEndpoint	Proprietà dell'oggetto endpoint privato.
PrivateEndpointConnectionItem	Elemento di connessione dell'endpoint privato.
PrivateEndpointConnectionProvisioningState	Stato di provisioning corrente.
PrivateEndpointServiceConnectionStatus	Stato della connessione dell'endpoint privato.
PrivateLinkServiceConnectionState	Oggetto che rappresenta lo stato di approvazione della connessione al collegamento privato.
SecretPermissions	Autorizzazioni per i segreti
Sku	Dettagli SKU
SkuFamily	Nome della famiglia di SKU
SkuName	Nome SKU per specificare se l'insieme di credenziali delle chiavi è un insieme di credenziali standard o un insieme di credenziali Premium.
StoragePermissions	Autorizzazioni per gli account di archiviazione
SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa dell'insieme di credenziali delle chiavi.
Vault	Informazioni sulle risorse con dettagli estesi.
VaultProperties	Proprietà dell'insieme di credenziali
VaultProvisioningState	Stato di provisioning dell'insieme di credenziali.
VirtualNetworkRule	Regola che regola l'accessibilità di un insieme di credenziali da una rete virtuale specifica.

AccessPolicyEntry

Identità che ha accesso all'insieme di credenziali delle chiavi. Tutte le identità nella matrice devono usare lo stesso ID tenant dell'ID tenant dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
applicationId	string	ID applicazione del client che effettua una richiesta per conto di un'entità
objectId	string	ID oggetto di un utente, di un'entità servizio o di un gruppo di sicurezza nel tenant di Azure Active Directory per l'insieme di credenziali. L'ID oggetto deve essere univoco per l'elenco dei criteri di accesso.
permissions	Permissions	Autorizzazioni per l'identità per chiavi, segreti e certificati.
tenantId	string	ID tenant di Azure Active Directory da usare per autenticare le richieste all'insieme di credenziali delle chiavi.

ActionsRequired

Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer.

Nome	Tipo	Descrizione
None	string

CertificatePermissions

Autorizzazioni per i certificati

Nome	Tipo	Descrizione
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

Risposta di errore da Key Vault provider di risorse

Nome	Tipo	Descrizione
error	CloudErrorBody	Risposta di errore da Key Vault provider di risorse

CloudErrorBody

Risposta di errore da Key Vault provider di risorse

Nome	Tipo	Descrizione
code	string	Codice di errore. Si tratta di un mnemonico che può essere utilizzato a livello di codice.
message	string	Messaggio di errore descrittivo. Il messaggio viene in genere localizzato e può variare con la versione del servizio.

CreateMode

Modalità di creazione dell'insieme di credenziali per indicare se l'insieme di credenziali deve essere recuperato o meno.

Nome	Tipo	Descrizione
default	string
recover	string

identityType

Tipo di identità che ha creato la risorsa dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

IPRule

Regola che regola l'accessibilità di un insieme di credenziali da un indirizzo IP o un intervallo ip specifico.

Nome	Tipo	Descrizione
value	string	Intervallo di indirizzi IPv4 nella notazione CIDR, ad esempio "124.56.78.91" (indirizzo IP semplice) o "124.56.78.0/24" (tutti gli indirizzi che iniziano con 124.56.78).

KeyPermissions

Autorizzazioni per le chiavi

Nome	Tipo	Descrizione
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

Azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrisponde. Questa opzione viene utilizzata solo dopo la valutazione della proprietà bypass.

Nome	Tipo	Descrizione
Allow	string
Deny	string

NetworkRuleBypassOptions

Indica il traffico che può ignorare le regole di rete. Può trattarsi di 'AzureServices' o 'None'. Se non è specificato, il valore predefinito è "AzureServices".

Nome	Tipo	Descrizione
AzureServices	string
None	string

NetworkRuleSet

Set di regole che regolano l'accessibilità di rete di un insieme di credenziali.

Nome	Tipo	Descrizione
bypass	NetworkRuleBypassOptions	Indica il traffico che può ignorare le regole di rete. Può trattarsi di 'AzureServices' o 'None'. Se non è specificato, il valore predefinito è "AzureServices".
defaultAction	NetworkRuleAction	Azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrisponde. Questa opzione viene utilizzata solo dopo la valutazione della proprietà bypass.
ipRules	IPRule[]	Elenco di regole di indirizzo IP.
virtualNetworkRules	VirtualNetworkRule[]	Elenco di regole di rete virtuale.

Permissions

Autorizzazioni per l'identità per chiavi, segreti, certificati e archiviazione.

Nome	Tipo	Descrizione
certificates	CertificatePermissions[]	Autorizzazioni per i certificati
keys	KeyPermissions[]	Autorizzazioni per le chiavi
secrets	SecretPermissions[]	Autorizzazioni per i segreti
storage	StoragePermissions[]	Autorizzazioni per gli account di archiviazione

PrivateEndpoint

Proprietà dell'oggetto endpoint privato.

Nome	Tipo	Descrizione
id	string	Identificatore completo della risorsa dell'endpoint privato.

PrivateEndpointConnectionItem

Elemento di connessione dell'endpoint privato.

Nome	Tipo	Descrizione
etag	string	Modifica ogni volta che si verifica una modifica dello stato della connessione all'endpoint privato.
id	string	ID della connessione all'endpoint privato.
properties.privateEndpoint	PrivateEndpoint	Proprietà dell'oggetto endpoint privato.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stato di approvazione della connessione di collegamento privato.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stato di provisioning della connessione dell'endpoint privato.

PrivateEndpointConnectionProvisioningState

Stato di provisioning corrente.

Nome	Tipo	Descrizione
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Stato della connessione dell'endpoint privato.

Nome	Tipo	Descrizione
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Oggetto che rappresenta lo stato di approvazione della connessione al collegamento privato.

Nome	Tipo	Descrizione
actionsRequired	ActionsRequired	Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer.
description	string	Motivo dell'approvazione o del rifiuto.
status	PrivateEndpointServiceConnectionStatus	Indica se la connessione è stata approvata, rifiutata o rimossa dal proprietario dell'insieme di credenziali delle chiavi.

SecretPermissions

Autorizzazioni per i segreti

Nome	Tipo	Descrizione
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	string

Sku

Dettagli SKU

Nome	Tipo	Descrizione
family	SkuFamily	Nome della famiglia di SKU
name	SkuName	Nome SKU per specificare se l'insieme di credenziali delle chiavi è un insieme di credenziali standard o un insieme di credenziali Premium.

SkuFamily

Nome della famiglia di SKU

Nome	Tipo	Descrizione
A	string

SkuName

Nome SKU per specificare se l'insieme di credenziali delle chiavi è un insieme di credenziali standard o un insieme di credenziali Premium.

Nome	Tipo	Descrizione
premium	string
standard	string

StoragePermissions

Autorizzazioni per gli account di archiviazione

Nome	Tipo	Descrizione
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

Metadati relativi alla creazione e all'ultima modifica della risorsa dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse dell'insieme di credenziali delle chiavi (UTC).
createdBy	string	Identità che ha creato la risorsa dell'insieme di credenziali delle chiavi.
createdByType	identityType	Tipo di identità che ha creato la risorsa dell'insieme di credenziali delle chiavi.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa dell'insieme di credenziali delle chiavi (UTC).
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa dell'insieme di credenziali delle chiavi.
lastModifiedByType	identityType	Tipo di identità che ha modificato l'ultima risorsa dell'insieme di credenziali delle chiavi.

Vault

Informazioni sulle risorse con dettagli estesi.

Nome	Tipo	Descrizione
id	string	Identificatore completo della risorsa dell'insieme di credenziali delle chiavi.
location	string	Posizione di Azure della risorsa dell'insieme di credenziali delle chiavi.
name	string	Nome della risorsa dell'insieme di credenziali delle chiavi.
properties	VaultProperties	Proprietà dell'insieme di credenziali
systemData	SystemData	Metadati di sistema per l'insieme di credenziali delle chiavi.
tags	object	Tag assegnati alla risorsa dell'insieme di credenziali delle chiavi.
type	string	Tipo di risorsa della risorsa dell'insieme di credenziali delle chiavi.

VaultProperties

Proprietà dell'insieme di credenziali

Nome	Tipo	Valore predefinito	Descrizione
accessPolicies	AccessPolicyEntry[]		Matrice di identità da 0 a 1024 che hanno accesso all'insieme di credenziali delle chiavi. Tutte le identità nella matrice devono usare lo stesso ID tenant dell'ID tenant dell'insieme di credenziali delle chiavi. Se `createMode` è impostato su `recover`, i criteri di accesso non sono necessari. In caso contrario, sono necessari criteri di accesso.
createMode	CreateMode		Modalità di creazione dell'insieme di credenziali per indicare se l'insieme di credenziali deve essere recuperato o meno.
enablePurgeProtection	boolean		Proprietà che specifica se la protezione dall'eliminazione è abilitata per questo insieme di credenziali. L'impostazione di questa proprietà su true attiva la protezione dall'eliminazione dell'insieme di credenziali e del relativo contenuto. Solo il servizio di Key Vault può avviare un'eliminazione irreversibile difficile. L'impostazione è valida solo se è abilitata anche l'eliminazione temporanea. L'abilitazione di questa funzionalità è irreversibile, ovvero la proprietà non accetta false come valore.
enableRbacAuthorization	boolean	False	Proprietà che controlla la modalità di autorizzazione delle azioni dei dati. Se true, l'insieme di credenziali delle chiavi userà il controllo degli Controllo di accesso accessi in base al ruolo (RBAC) per l'autorizzazione delle azioni dati e i criteri di accesso specificati nelle proprietà dell'insieme di credenziali verranno ignorati. Se false, l'insieme di credenziali delle chiavi userà i criteri di accesso specificati nelle proprietà dell'insieme di credenziali e tutti i criteri archiviati in Azure Resource Manager verranno ignorati. Se null o non è specificato, l'insieme di credenziali viene creato con il valore predefinito false. Si noti che le azioni di gestione sono sempre autorizzate con il controllo degli accessi in base al ruolo.
enableSoftDelete	boolean	True	Proprietà per specificare se la funzionalità di eliminazione temporanea è abilitata per questo insieme di credenziali delle chiavi. Se non è impostato su alcun valore (true o false) durante la creazione di un nuovo insieme di credenziali delle chiavi, verrà impostato su true per impostazione predefinita. Una volta impostato su true, non può essere ripristinato su false.
enabledForDeployment	boolean		Proprietà per specificare se Azure Macchine virtuali è autorizzato a recuperare i certificati archiviati come segreti dall'insieme di credenziali delle chiavi.
enabledForDiskEncryption	boolean		Proprietà per specificare se Crittografia dischi di Azure è autorizzato a recuperare i segreti dall'insieme di credenziali e annullare il wrapping delle chiavi.
enabledForTemplateDeployment	boolean		Proprietà per specificare se Azure Resource Manager è autorizzato a recuperare i segreti dall'insieme di credenziali delle chiavi.
hsmPoolResourceId	string		ID risorsa del pool HSM.
networkAcls	NetworkRuleSet		Regole che regolano l'accessibilità dell'insieme di credenziali delle chiavi da percorsi di rete specifici.
privateEndpointConnections	PrivateEndpointConnectionItem[]		Elenco di connessioni di endpoint privato associate all'insieme di credenziali delle chiavi.
provisioningState	VaultProvisioningState		Stato di provisioning dell'insieme di credenziali.
publicNetworkAccess	string	enabled	Proprietà per specificare se l'insieme di credenziali accetterà il traffico da Internet pubblico. Se impostato su "disabilitato" tutto il traffico, ad eccezione del traffico dell'endpoint privato e che ha origine da servizi attendibili, verrà bloccato. In questo modo verranno ignorate le regole del firewall impostate, ovvero anche se le regole del firewall sono presenti non verranno rispettate.
sku	Sku		Dettagli SKU
softDeleteRetentionInDays	integer	90	softDelete data retention days (Giorni di conservazione dei dati softDelete). Accetta >=7 e <=90.
tenantId	string		ID tenant di Azure Active Directory da usare per autenticare le richieste all'insieme di credenziali delle chiavi.
vaultUri	string		URI dell'insieme di credenziali per l'esecuzione di operazioni su chiavi e segreti.

VaultProvisioningState

Stato di provisioning dell'insieme di credenziali.

Nome	Tipo	Descrizione
RegisteringDns	string
Succeeded	string

VirtualNetworkRule

Regola che regola l'accessibilità di un insieme di credenziali da una rete virtuale specifica.

Nome	Tipo	Descrizione
id	string	ID risorsa completo di una subnet della rete virtuale, ad esempio "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".
ignoreMissingVnetServiceEndpoint	boolean	Proprietà per specificare se NRP ignorerà il controllo se la subnet padre ha serviceEndpoints configurato.

Share via