Vaults - List By Resource Group
L’opération List obtient des informations sur les coffres associés à l’abonnement et au sein du groupe de ressources spécifié.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults?api-version=2022-07-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults?$top={$top}&api-version=2022-07-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Nom du groupe de ressources auquel appartient le coffre. |
subscription
|
path | True |
string |
Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service. |
api-version
|
query | True |
string |
Version de l’API cliente. |
$top
|
query |
integer int32 |
Nombre maximal de résultats à renvoyer. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Obtenez des informations sur tous les coffres de clés dans le groupe de ressources spécifié. |
|
Other Status Codes |
Réponse d’erreur décrivant la raison de l’échec de l’opération. |
Exemples
List vaults in the specified resource group
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/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults?api-version=2022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}
Définitions
Nom | Description |
---|---|
Access |
Une identité qui a accès au coffre de clés. Toutes les identités du tableau doivent utiliser le même ID de locataire que l’ID de locataire du coffre de clés. |
Actions |
Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur. |
Certificate |
Autorisations sur les certificats |
Cloud |
Réponse d’erreur de Key Vault fournisseur de ressources |
Cloud |
Réponse d’erreur de Key Vault fournisseur de ressources |
Create |
Mode de création du coffre pour indiquer si le coffre doit être récupéré ou non. |
identity |
Type d’identité qui a créé la ressource de coffre de clés. |
IPRule |
Règle régissant l’accessibilité d’un coffre à partir d’une adresse IP ou d’une plage d’adresses IP spécifiques. |
Key |
Autorisations sur les clés |
Network |
Action par défaut quand aucune règle d’ipRules et de virtualNetworkRules ne correspondent. Elle est utilisée uniquement après l’évaluation de la propriété bypass. |
Network |
Indique quel trafic peut contourner les règles réseau. Il peut s’agir de « AzureServices » ou de « Aucun ». S’il n’est pas spécifié, la valeur par défaut est « AzureServices ». |
Network |
Ensemble de règles régissant l’accessibilité réseau d’un coffre. |
Permissions |
Autorisations dont dispose l’identité pour les clés, les secrets, les certificats et le stockage. |
Private |
Propriétés de l’objet de point de terminaison privé. |
Private |
Élément de connexion de point de terminaison privé. |
Private |
État d’approvisionnement actuel. |
Private |
La connexion de point de terminaison privé status. |
Private |
Objet qui représente l’état d’approbation de la connexion de liaison privée. |
Secret |
Autorisations sur les secrets |
Sku |
Détails de la référence SKU |
Sku |
Nom de la famille de référence SKU |
Sku |
Nom de la référence SKU pour spécifier si le coffre de clés est un coffre standard ou un coffre Premium. |
Storage |
Autorisations sur les comptes de stockage |
System |
Métadonnées relatives à la création et à la dernière modification de la ressource de coffre de clés. |
Vault |
Informations sur les ressources avec des détails étendus. |
Vault |
Liste des coffres |
Vault |
Propriétés du coffre |
Vault |
État d’approvisionnement du coffre. |
Virtual |
Règle régissant l’accessibilité d’un coffre à partir d’un réseau virtuel spécifique. |
AccessPolicyEntry
Une identité qui a accès au coffre de clés. Toutes les identités du tableau doivent utiliser le même ID de locataire que l’ID de locataire du coffre de clés.
Nom | Type | Description |
---|---|---|
applicationId |
string |
ID d’application du client effectuant une demande pour le compte d’un principal |
objectId |
string |
ID d’objet d’un utilisateur, d’un principal de service ou d’un groupe de sécurité dans le locataire Azure Active Directory pour le coffre. Cet ID d’objet doit être unique dans la liste des stratégies d’accès. |
permissions |
Autorisations dont dispose l’identité pour les clés, les secrets et les certificats. |
|
tenantId |
string |
ID de locataire Azure Active Directory qui doit être utilisé pour l’authentification des demandes adressées au coffre de clés. |
ActionsRequired
Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.
Nom | Type | Description |
---|---|---|
None |
string |
CertificatePermissions
Autorisations sur les certificats
Nom | Type | 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
Réponse d’erreur de Key Vault fournisseur de ressources
Nom | Type | Description |
---|---|---|
error |
Réponse d’erreur de Key Vault fournisseur de ressources |
CloudErrorBody
Réponse d’erreur de Key Vault fournisseur de ressources
Nom | Type | Description |
---|---|---|
code |
string |
Code d’erreur. Il s’agit d’un mnémonique qui peut être consommé par programmation. |
message |
string |
Message d’erreur convivial. Le message est généralement localisé et peut varier en fonction de la version du service. |
CreateMode
Mode de création du coffre pour indiquer si le coffre doit être récupéré ou non.
Nom | Type | Description |
---|---|---|
default |
string |
|
recover |
string |
identityType
Type d’identité qui a créé la ressource de coffre de clés.
Nom | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
IPRule
Règle régissant l’accessibilité d’un coffre à partir d’une adresse IP ou d’une plage d’adresses IP spécifiques.
Nom | Type | Description |
---|---|---|
value |
string |
Une plage d’adresses IPv4 en notation CIDR, telle que « 124.56.78.91 » (adresse IP simple) ou « 124.56.78.0/24 » (toutes les adresses qui commencent par 124.56.78). |
KeyPermissions
Autorisations sur les clés
Nom | Type | 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
Action par défaut quand aucune règle d’ipRules et de virtualNetworkRules ne correspondent. Elle est utilisée uniquement après l’évaluation de la propriété bypass.
Nom | Type | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
NetworkRuleBypassOptions
Indique quel trafic peut contourner les règles réseau. Il peut s’agir de « AzureServices » ou de « Aucun ». S’il n’est pas spécifié, la valeur par défaut est « AzureServices ».
Nom | Type | Description |
---|---|---|
AzureServices |
string |
|
None |
string |
NetworkRuleSet
Ensemble de règles régissant l’accessibilité réseau d’un coffre.
Nom | Type | Description |
---|---|---|
bypass |
Indique quel trafic peut contourner les règles réseau. Il peut s’agir de « AzureServices » ou de « Aucun ». S’il n’est pas spécifié, la valeur par défaut est « AzureServices ». |
|
defaultAction |
Action par défaut quand aucune règle d’ipRules et de virtualNetworkRules ne correspondent. Elle est utilisée uniquement après l’évaluation de la propriété bypass. |
|
ipRules |
IPRule[] |
Liste des règles d’adresse IP. |
virtualNetworkRules |
Liste des règles de réseau virtuel. |
Permissions
Autorisations dont dispose l’identité pour les clés, les secrets, les certificats et le stockage.
Nom | Type | Description |
---|---|---|
certificates |
Autorisations sur les certificats |
|
keys |
Autorisations sur les clés |
|
secrets |
Autorisations sur les secrets |
|
storage |
Autorisations sur les comptes de stockage |
PrivateEndpoint
Propriétés de l’objet de point de terminaison privé.
Nom | Type | Description |
---|---|---|
id |
string |
Identificateur complet de la ressource de point de terminaison privé. |
PrivateEndpointConnectionItem
Élément de connexion de point de terminaison privé.
Nom | Type | Description |
---|---|---|
etag |
string |
Modifié chaque fois qu’il y a un changement dans l’état de la connexion de point de terminaison privé. |
id |
string |
ID de la connexion de point de terminaison privé. |
properties.privateEndpoint |
Propriétés de l’objet de point de terminaison privé. |
|
properties.privateLinkServiceConnectionState |
État d’approbation de la connexion de liaison privée. |
|
properties.provisioningState |
État d’approvisionnement de la connexion de point de terminaison privé. |
PrivateEndpointConnectionProvisioningState
État d’approvisionnement actuel.
Nom | Type | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Disconnected |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
PrivateEndpointServiceConnectionStatus
La connexion de point de terminaison privé status.
Nom | Type | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
Objet qui représente l’état d’approbation de la connexion de liaison privée.
Nom | Type | Description |
---|---|---|
actionsRequired |
Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur. |
|
description |
string |
Motif de l’approbation ou du rejet. |
status |
Indique si la connexion a été approuvée, rejetée ou supprimée par le propriétaire du coffre de clés. |
SecretPermissions
Autorisations sur les secrets
Nom | Type | Description |
---|---|---|
all |
string |
|
backup |
string |
|
delete |
string |
|
get |
string |
|
list |
string |
|
purge |
string |
|
recover |
string |
|
restore |
string |
|
set |
string |
Sku
Détails de la référence SKU
Nom | Type | Description |
---|---|---|
family |
Nom de la famille de référence SKU |
|
name |
Nom de la référence SKU pour spécifier si le coffre de clés est un coffre standard ou un coffre Premium. |
SkuFamily
Nom de la famille de référence SKU
Nom | Type | Description |
---|---|---|
A |
string |
SkuName
Nom de la référence SKU pour spécifier si le coffre de clés est un coffre standard ou un coffre Premium.
Nom | Type | Description |
---|---|---|
premium |
string |
|
standard |
string |
StoragePermissions
Autorisations sur les comptes de stockage
Nom | Type | 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
Métadonnées relatives à la création et à la dernière modification de la ressource de coffre de clés.
Nom | Type | Description |
---|---|---|
createdAt |
string |
Horodatage de la création de la ressource de coffre de clés (UTC). |
createdBy |
string |
Identité qui a créé la ressource de coffre de clés. |
createdByType |
Type d’identité qui a créé la ressource de coffre de clés. |
|
lastModifiedAt |
string |
Horodatage de la dernière modification (UTC) de la ressource de coffre de clés. |
lastModifiedBy |
string |
Identité qui a modifié la dernière ressource de coffre de clés. |
lastModifiedByType |
Type d’identité qui a modifié la dernière ressource de coffre de clés. |
Vault
Informations sur les ressources avec des détails étendus.
Nom | Type | Description |
---|---|---|
id |
string |
Identificateur complet de la ressource de coffre de clés. |
location |
string |
Emplacement Azure de la ressource de coffre de clés. |
name |
string |
Nom de la ressource de coffre de clés. |
properties |
Propriétés du coffre |
|
systemData |
Métadonnées système pour le coffre de clés. |
|
tags |
object |
Étiquettes affectées à la ressource de coffre de clés. |
type |
string |
Type de ressource de la ressource de coffre de clés. |
VaultListResult
Liste des coffres
Nom | Type | Description |
---|---|---|
nextLink |
string |
URL permettant d’obtenir l’ensemble de coffres suivant. |
value |
Vault[] |
Liste des coffres. |
VaultProperties
Propriétés du coffre
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
accessPolicies |
Tableau de 0 à 1 024 identités ayant accès au coffre de clés. Toutes les identités du tableau doivent utiliser le même ID de locataire que l’ID de locataire du coffre de clés. Lorsque |
||
createMode |
Mode de création du coffre pour indiquer si le coffre doit être récupéré ou non. |
||
enablePurgeProtection |
boolean |
Propriété spécifiant si la protection contre le vidage est activée pour ce coffre. La définition de cette propriété sur true active la protection contre le vidage de ce coffre et de son contenu. Seul le service Key Vault peut initier une suppression définitive et irrécupérable. Le paramètre n’est effectif que si la suppression réversible est également activée. L’activation de cette fonctionnalité est irréversible, c’est-à-dire que la propriété n’accepte pas false comme valeur. |
|
enableRbacAuthorization |
boolean |
False |
Propriété qui contrôle la façon dont les actions de données sont autorisées. Lorsque la valeur est true, le coffre de clés utilise le Access Control en fonction du rôle (RBAC) pour l’autorisation des actions de données, et les stratégies d’accès spécifiées dans les propriétés du coffre sont ignorées. Si la valeur est false, le coffre de clés utilise les stratégies d’accès spécifiées dans les propriétés du coffre, et toute stratégie stockée sur Azure Resource Manager est ignorée. Si null ou n’est pas spécifié, le coffre est créé avec la valeur par défaut false. Notez que les actions de gestion sont toujours autorisées avec RBAC. |
enableSoftDelete |
boolean |
True |
Propriété permettant de spécifier si la fonctionnalité de « suppression réversible » est activée pour ce coffre de clés. S’il n’est défini sur aucune valeur (true ou false) lors de la création d’un coffre de clés, il est défini sur true par défaut. Une fois défini sur true, il ne peut pas être rétabli sur false. |
enabledForDeployment |
boolean |
Propriété permettant de spécifier si les Machines Virtuelles Azure sont autorisés à récupérer des certificats stockés en tant que secrets à partir du coffre de clés. |
|
enabledForDiskEncryption |
boolean |
Propriété permettant de spécifier si Azure Disk Encryption est autorisé à récupérer des secrets à partir du coffre et à désencapsuler les clés. |
|
enabledForTemplateDeployment |
boolean |
Propriété permettant de spécifier si Azure Resource Manager est autorisé à récupérer des secrets du coffre de clés. |
|
hsmPoolResourceId |
string |
ID de ressource du pool HSM. |
|
networkAcls |
Règles régissant l’accessibilité du coffre de clés à partir d’emplacements réseau spécifiques. |
||
privateEndpointConnections |
Liste des connexions de point de terminaison privé associées au coffre de clés. |
||
provisioningState |
État d’approvisionnement du coffre. |
||
publicNetworkAccess |
string |
enabled |
Propriété permettant de spécifier si le coffre accepte le trafic provenant de l’Internet public. S’il est défini sur « désactivé », tout le trafic à l’exception du point de terminaison privé et qui provient de services approuvés sera bloqué. Cela remplacera les règles de pare-feu définies, ce qui signifie que même si les règles de pare-feu sont présentes, nous ne respecterons pas les règles. |
sku |
Détails de la référence SKU |
||
softDeleteRetentionInDays |
integer |
90 |
softDelete data retention days. Il accepte >=7 et <=90. |
tenantId |
string |
ID de locataire Azure Active Directory qui doit être utilisé pour l’authentification des demandes adressées au coffre de clés. |
|
vaultUri |
string |
URI du coffre pour effectuer des opérations sur les clés et les secrets. |
VaultProvisioningState
État d’approvisionnement du coffre.
Nom | Type | Description |
---|---|---|
RegisteringDns |
string |
|
Succeeded |
string |
VirtualNetworkRule
Règle régissant l’accessibilité d’un coffre à partir d’un réseau virtuel spécifique.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource complet d’un sous-réseau de réseau virtuel, tel que « /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnets/subnets1 ». |
ignoreMissingVnetServiceEndpoint |
boolean |
Propriété permettant de spécifier si le NRP ignore le case activée si le sous-réseau parent a serviceEndpoints configurés. |