Vaults - List By Subscription
La operación List obtiene información sobre los almacenes asociados a la suscripción.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/vaults?api-version=2022-07-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/vaults?$top={$top}&api-version=2022-07-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio. |
api-version
|
query | True |
string |
Versión de api de cliente. |
$top
|
query |
integer int32 |
El número máximo de resultados que se devolverán. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Obtenga información sobre todos los almacenes de claves de la suscripción especificada. |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de la operación. |
Ejemplos
List vaults in the specified subscription
Sample Request
Sample Response
{
"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=="
}
Definiciones
Nombre | Description |
---|---|
Access |
Identidad que tiene acceso al almacén de claves. Todas las identidades de la matriz deben usar el mismo identificador de inquilino que el identificador de inquilino del almacén de claves. |
Actions |
Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor. |
Certificate |
Permisos para certificados |
Cloud |
Respuesta de error del proveedor de recursos de Key Vault |
Cloud |
Respuesta de error del proveedor de recursos de Key Vault |
Create |
Modo de creación del almacén para indicar si el almacén debe recuperarse o no. |
identity |
Tipo de identidad que creó el recurso del almacén de claves. |
IPRule |
Una regla que rige la accesibilidad de un almacén desde una dirección IP específica o un intervalo ip. |
Key |
Permisos para claves |
Network |
Acción predeterminada cuando no coinciden ninguna regla de ipRules y de virtualNetworkRules. Esto solo se usa después de evaluar la propiedad bypass. |
Network |
Indica qué tráfico puede omitir las reglas de red. Puede ser "AzureServices" o "None". Si no se especifica el valor predeterminado es "AzureServices". |
Network |
Conjunto de reglas que rigen la accesibilidad de red de un almacén. |
Permissions |
Permisos que la identidad tiene para claves, secretos, certificados y almacenamiento. |
Private |
Propiedades del objeto de punto de conexión privado. |
Private |
Elemento de conexión de punto de conexión privado. |
Private |
Estado de aprovisionamiento actual. |
Private |
Estado de conexión del punto de conexión privado. |
Private |
Objeto que representa el estado de aprobación de la conexión de vínculo privado. |
Secret |
Permisos para secretos |
Sku |
Detalles de la SKU |
Sku |
Nombre de familia de SKU |
Sku |
Nombre de la SKU para especificar si el almacén de claves es un almacén estándar o un almacén Premium. |
Storage |
Permisos para cuentas de almacenamiento |
System |
Metadatos relacionados con la creación y la última modificación del recurso del almacén de claves. |
Vault |
Información de recursos con detalles extendidos. |
Vault |
Lista de almacenes |
Vault |
Propiedades del almacén |
Vault |
Estado de aprovisionamiento del almacén. |
Virtual |
Una regla que rige la accesibilidad de un almacén desde una red virtual específica. |
AccessPolicyEntry
Identidad que tiene acceso al almacén de claves. Todas las identidades de la matriz deben usar el mismo identificador de inquilino que el identificador de inquilino del almacén de claves.
Nombre | Tipo | Description |
---|---|---|
applicationId |
string |
Identificador de aplicación del cliente que realiza una solicitud en nombre de una entidad de seguridad |
objectId |
string |
Identificador de objeto de un usuario, una entidad de servicio o un grupo de seguridad en el inquilino de Azure Active Directory para el almacén. El identificador de objeto debe ser único para la lista de directivas de acceso. |
permissions |
Permisos que la identidad tiene para claves, secretos y certificados. |
|
tenantId |
string |
Identificador de inquilino de Azure Active Directory que se debe usar para autenticar solicitudes en el almacén de claves. |
ActionsRequired
Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
Nombre | Tipo | Description |
---|---|---|
None |
string |
CertificatePermissions
Permisos para certificados
Nombre | Tipo | 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
Respuesta de error del proveedor de recursos de Key Vault
Nombre | Tipo | Description |
---|---|---|
error |
Respuesta de error del proveedor de recursos de Key Vault |
CloudErrorBody
Respuesta de error del proveedor de recursos de Key Vault
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error. Se trata de una mnemónica que se puede consumir mediante programación. |
message |
string |
Mensaje de error descriptivo. El mensaje suele localizarse y puede variar con la versión del servicio. |
CreateMode
Modo de creación del almacén para indicar si el almacén debe recuperarse o no.
Nombre | Tipo | Description |
---|---|---|
default |
string |
|
recover |
string |
identityType
Tipo de identidad que creó el recurso del almacén de claves.
Nombre | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
IPRule
Una regla que rige la accesibilidad de un almacén desde una dirección IP específica o un intervalo ip.
Nombre | Tipo | Description |
---|---|---|
value |
string |
Intervalo de direcciones IPv4 en notación CIDR, como "124.56.78.91" (dirección IP simple) o "124.56.78.0/24" (todas las direcciones que comienzan por 124.56.78). |
KeyPermissions
Permisos para claves
Nombre | Tipo | 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
Acción predeterminada cuando no coinciden ninguna regla de ipRules y de virtualNetworkRules. Esto solo se usa después de evaluar la propiedad bypass.
Nombre | Tipo | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
NetworkRuleBypassOptions
Indica qué tráfico puede omitir las reglas de red. Puede ser "AzureServices" o "None". Si no se especifica el valor predeterminado es "AzureServices".
Nombre | Tipo | Description |
---|---|---|
AzureServices |
string |
|
None |
string |
NetworkRuleSet
Conjunto de reglas que rigen la accesibilidad de red de un almacén.
Nombre | Tipo | Description |
---|---|---|
bypass |
Indica qué tráfico puede omitir las reglas de red. Puede ser "AzureServices" o "None". Si no se especifica el valor predeterminado es "AzureServices". |
|
defaultAction |
Acción predeterminada cuando no coinciden ninguna regla de ipRules y de virtualNetworkRules. Esto solo se usa después de evaluar la propiedad bypass. |
|
ipRules |
IPRule[] |
Lista de reglas de direcciones IP. |
virtualNetworkRules |
Lista de reglas de red virtual. |
Permissions
Permisos que la identidad tiene para claves, secretos, certificados y almacenamiento.
Nombre | Tipo | Description |
---|---|---|
certificates |
Permisos para certificados |
|
keys |
Permisos para claves |
|
secrets |
Permisos para secretos |
|
storage |
Permisos para cuentas de almacenamiento |
PrivateEndpoint
Propiedades del objeto de punto de conexión privado.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador completo del recurso de punto de conexión privado. |
PrivateEndpointConnectionItem
Elemento de conexión de punto de conexión privado.
Nombre | Tipo | Description |
---|---|---|
etag |
string |
Se modifica cada vez que hay un cambio en el estado de la conexión de punto de conexión privado. |
id |
string |
Identificador de la conexión de punto de conexión privado. |
properties.privateEndpoint |
Propiedades del objeto de punto de conexión privado. |
|
properties.privateLinkServiceConnectionState |
Estado de aprobación de la conexión de vínculo privado. |
|
properties.provisioningState |
Estado de aprovisionamiento de la conexión de punto de conexión privado. |
PrivateEndpointConnectionProvisioningState
Estado de aprovisionamiento actual.
Nombre | Tipo | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Disconnected |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
PrivateEndpointServiceConnectionStatus
Estado de conexión del punto de conexión privado.
Nombre | Tipo | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
Objeto que representa el estado de aprobación de la conexión de vínculo privado.
Nombre | Tipo | Description |
---|---|---|
actionsRequired |
Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor. |
|
description |
string |
Motivo de aprobación o rechazo. |
status |
Indica si el propietario del almacén de claves ha aprobado, rechazado o quitado la conexión. |
SecretPermissions
Permisos para secretos
Nombre | Tipo | Description |
---|---|---|
all |
string |
|
backup |
string |
|
delete |
string |
|
get |
string |
|
list |
string |
|
purge |
string |
|
recover |
string |
|
restore |
string |
|
set |
string |
Sku
Detalles de la SKU
Nombre | Tipo | Description |
---|---|---|
family |
Nombre de familia de SKU |
|
name |
Nombre de la SKU para especificar si el almacén de claves es un almacén estándar o un almacén Premium. |
SkuFamily
Nombre de familia de SKU
Nombre | Tipo | Description |
---|---|---|
A |
string |
SkuName
Nombre de la SKU para especificar si el almacén de claves es un almacén estándar o un almacén Premium.
Nombre | Tipo | Description |
---|---|---|
premium |
string |
|
standard |
string |
StoragePermissions
Permisos para cuentas de almacenamiento
Nombre | Tipo | 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
Metadatos relacionados con la creación y la última modificación del recurso del almacén de claves.
Nombre | Tipo | Description |
---|---|---|
createdAt |
string |
Marca de tiempo de la creación de recursos del almacén de claves (UTC). |
createdBy |
string |
Identidad que creó el recurso del almacén de claves. |
createdByType |
Tipo de identidad que creó el recurso del almacén de claves. |
|
lastModifiedAt |
string |
Marca de tiempo de la última modificación del recurso del almacén de claves (UTC). |
lastModifiedBy |
string |
Identidad que modificó por última vez el recurso del almacén de claves. |
lastModifiedByType |
Tipo de identidad que modificó por última vez el recurso del almacén de claves. |
Vault
Información de recursos con detalles extendidos.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador completo del recurso del almacén de claves. |
location |
string |
Ubicación de Azure del recurso del almacén de claves. |
name |
string |
Nombre del recurso del almacén de claves. |
properties |
Propiedades del almacén |
|
systemData |
Metadatos del sistema para el almacén de claves. |
|
tags |
object |
Etiquetas asignadas al recurso del almacén de claves. |
type |
string |
Tipo de recurso del recurso del almacén de claves. |
VaultListResult
Lista de almacenes
Nombre | Tipo | Description |
---|---|---|
nextLink |
string |
Dirección URL para obtener el siguiente conjunto de almacenes. |
value |
Vault[] |
Lista de almacenes. |
VaultProperties
Propiedades del almacén
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
accessPolicies |
Matriz de 0 a 1024 identidades que tienen acceso al almacén de claves. Todas las identidades de la matriz deben usar el mismo identificador de inquilino que el identificador de inquilino del almacén de claves. Cuando |
||
createMode |
Modo de creación del almacén para indicar si el almacén debe recuperarse o no. |
||
enablePurgeProtection |
boolean |
Propiedad que especifica si la protección contra purga está habilitada para este almacén. Al establecer esta propiedad en true, se activa la protección contra la purga de este almacén y su contenido: solo el servicio de Key Vault puede iniciar una eliminación irrecuperable e irrecuperable. La configuración solo es efectiva si la eliminación temporal también está habilitada. Habilitar esta funcionalidad es irreversible; es decir, la propiedad no acepta false como su valor. |
|
enableRbacAuthorization |
boolean |
False |
Propiedad que controla cómo se autorizan las acciones de datos. Cuando sea true, el almacén de claves usará Access Control basado en roles (RBAC) para la autorización de acciones de datos y se omitirán las directivas de acceso especificadas en las propiedades del almacén. Cuando es false, el almacén de claves usará las directivas de acceso especificadas en las propiedades del almacén y se omitirá cualquier directiva almacenada en Azure Resource Manager. Si se especifica null o no, el almacén se crea con el valor predeterminado false. Tenga en cuenta que las acciones de administración siempre están autorizadas con RBAC. |
enableSoftDelete |
boolean |
True |
Propiedad para especificar si la funcionalidad de "eliminación temporal" está habilitada para este almacén de claves. Si no se establece en ningún valor (true o false) al crear un nuevo almacén de claves, se establecerá en true de forma predeterminada. Una vez establecido en true, no se puede revertir a false. |
enabledForDeployment |
boolean |
Propiedad para especificar si se permite que Azure Virtual Machines recupere certificados almacenados como secretos del almacén de claves. |
|
enabledForDiskEncryption |
boolean |
Propiedad para especificar si Azure Disk Encryption puede recuperar secretos del almacén y desencapsular las claves. |
|
enabledForTemplateDeployment |
boolean |
Propiedad para especificar si Se permite que Azure Resource Manager recupere secretos del almacén de claves. |
|
hsmPoolResourceId |
string |
Identificador de recurso del grupo de HSM. |
|
networkAcls |
Reglas que rigen la accesibilidad del almacén de claves desde ubicaciones de red específicas. |
||
privateEndpointConnections |
Lista de conexiones de punto de conexión privado asociadas al almacén de claves. |
||
provisioningState |
Estado de aprovisionamiento del almacén. |
||
publicNetworkAccess |
string |
enabled |
Propiedad para especificar si el almacén aceptará el tráfico de la red pública de Internet. Si se establece en "deshabilitado", todo el tráfico excepto el tráfico de punto de conexión privado y que se origina en servicios de confianza se bloqueará. Esto invalidará las reglas de firewall establecidas, lo que significa que aunque las reglas de firewall estén presentes, no respetaremos las reglas. |
sku |
Detalles de la SKU |
||
softDeleteRetentionInDays |
integer |
90 |
días de retención de datos softDelete. Acepta >=7 y <=90. |
tenantId |
string |
Identificador de inquilino de Azure Active Directory que se debe usar para autenticar solicitudes en el almacén de claves. |
|
vaultUri |
string |
URI del almacén para realizar operaciones en claves y secretos. |
VaultProvisioningState
Estado de aprovisionamiento del almacén.
Nombre | Tipo | Description |
---|---|---|
RegisteringDns |
string |
|
Succeeded |
string |
VirtualNetworkRule
Una regla que rige la accesibilidad de un almacén desde una red virtual específica.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso completo de una subred de red virtual, como "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1". |
ignoreMissingVnetServiceEndpoint |
boolean |
Propiedad para especificar si NRP omitirá la comprobación si la subred primaria tiene serviceEndpoints configurado. |