Get-AzKeyVault

Référence

Module:: Az.KeyVault

Obtient les coffres de clés.

Syntaxe

Get-AzKeyVault
   [[-VaultName] <String>]
   [[-ResourceGroupName] <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Get-AzKeyVault
   [-VaultName] <String>
   [-Location] <String>
   [-InRemovedState]
   [-DefaultProfile <IAzureContextContainer>]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Get-AzKeyVault
   [-InRemovedState]
   [-DefaultProfile <IAzureContextContainer>]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Description

L’applet de commande Get-AzKeyVault obtient des informations sur les coffres de clés d’un abonnement. Vous pouvez afficher toutes les instances de coffres de clés dans un abonnement, ou filtrer vos résultats par un groupe de ressources ou un coffre de clés particulier. Notez que bien que la spécification du groupe de ressources soit facultative pour cette applet de commande lorsque vous obtenez un coffre de clés unique, vous devez le faire pour de meilleures performances.

L’applet de commande peut appeler sous l’API Microsoft Graph en fonction des paramètres d’entrée :

GET /directoryObjects/{id}
GET /users/{id}
GET /servicePrincipals/{id}
GET /groups/{id}

Exemples

Exemple 1 : Obtenir tous les coffres de clés dans votre abonnement actuel

Get-AzKeyVault

Vault Name          : myvault1
Resource Group Name : myrg
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.Ke
                      yVault/vaults/myvault1
Tags                :


Vault Name          : myvault2
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault2
Tags                :

Vault Name          : myvault3
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault3
Tags                :

Cette commande obtient tous les coffres de clés de votre abonnement actuel.

Exemple 2 : Obtenir un coffre de clés spécifique

Get-AzKeyVault -VaultName 'myvault'

Vault Name                       : myvault
Resource Group Name              : myrg
Location                         : westus
Resource ID                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers
                                   /Microsoft.KeyVault/vaults/myvault
Vault URI                        : https://myvault.vault.azure.net/
Tenant ID                        : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU                              : Standard
Enabled For Deployment?          : True
Enabled For Template Deployment? : True
Enabled For Disk Encryption?     : False
Soft Delete Enabled?             : True
Access Policies                  :
                                   Tenant ID                                  : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
                                   Object ID                                  : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
                                   Application ID                             :
                                   Display Name                               : User Name (username@microsoft.com)
                                   Permissions to Keys                        : get, create, delete, list, update,
                                   import, backup, restore, recover
                                   Permissions to Secrets                     : get, list, set, delete, backup,
                                   restore, recover
                                   Permissions to Certificates                : get, delete, list, create, import,
                                   update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers,
                                   setissuers, recover
                                   Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list,
                                   listsas, regeneratekey, set, setsas, update

Tags                             :

Cette commande obtient le coffre de clés nommé myvault dans votre abonnement actuel.

Exemple 3 : Obtenir des coffres de clés dans un groupe de ressources

Get-AzKeyVault -ResourceGroupName 'myrg1'

Vault Name          : myvault2
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault2
Tags                :

Vault Name          : myvault3
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault3
Tags                :

Cette commande obtient tous les coffres de clés du groupe de ressources nommé ContosoPayRollResourceGroup.

Exemple 4 : Obtenir tous les coffres de clés supprimés dans votre abonnement actuel

Get-AzKeyVault -InRemovedState

Vault Name           : myvault4
Location             : westus
Id                   : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/providers/Microsoft.KeyVault/locations/westu
                       s/deletedVaults/myvault4
Resource ID          : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.K
                       eyVault/vaults/myvault4
Deletion Date        : 5/24/2018 9:33:24 PM
Scheduled Purge Date : 8/22/2018 9:33:24 PM
Tags                 :

Cette commande obtient tous les coffres de clés supprimés dans votre abonnement actuel.

Exemple 5 : Obtenir un coffre de clés supprimé

Get-AzKeyVault -VaultName 'myvault4'  -Location 'westus' -InRemovedState

Vault Name           : myvault4
Location             : westus
Id                   : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/providers/Microsoft.KeyVault/locations/westu
                       s/deletedVaults/myvault4
Resource ID          : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.K
                       eyVault/vaults/myvault4
Deletion Date        : 5/24/2018 9:33:24 PM
Scheduled Purge Date : 8/22/2018 9:33:24 PM
Tags                 :

Cette commande obtient les informations de coffre de clés supprimées nommées myvault4 dans votre abonnement actuel et dans la région westus.

Exemple 6 : Obtenir des coffres de clés à l’aide du filtrage

Get-AzKeyVault -VaultName 'myvault*'

Vault Name          : myvault2
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault2
Tags                :

Vault Name          : myvault3
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault3
Tags                :

Cette commande obtient tous les coffres de clés de l’abonnement qui commencent par « myvault ».

Paramètres

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure

Type:	IAzureContextContainer
Alias:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-InRemovedState

Spécifie s’il faut afficher les coffres précédemment supprimés dans la sortie.

Type:	SwitchParameter
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Location

Emplacement du coffre supprimé.

Type:	String
Position:	1
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ResourceGroupName

Spécifie le nom du groupe de ressources associé au coffre de clés ou aux coffres de clés interrogés.

Type:	String
Position:	1
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	True

-SubscriptionId

ID de l'abonnement. Par défaut, les applets de commande sont exécutées dans l’abonnement défini dans le contexte actuel. Si l’utilisateur spécifie un autre abonnement, l’applet de commande actuelle est exécutée dans l’abonnement spécifié par l’utilisateur. La substitution d’abonnements prend effet uniquement pendant le cycle de vie de l’applet de commande actuelle. Il ne modifie pas l’abonnement dans le contexte et n’affecte pas les applets de commande suivantes.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-Tag

Paires clé-valeur sous la forme d’une table de hachage. Par exemple : @{key0="value0 » ; key1=$null ; key2="value2"}

Type:	Hashtable
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-VaultName

Spécifie le nom du coffre de clés.

Type:	String
Alias:	Name
Position:	0
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	True

Entrées

String

Hashtable

Sorties

PSKeyVault

PSKeyVaultIdentityItem

PSDeletedKeyVault

Partager via

Get-AzKeyVault

Syntaxe

Description

Exemples

Exemple 1 : Obtenir tous les coffres de clés dans votre abonnement actuel

Exemple 2 : Obtenir un coffre de clés spécifique

Exemple 3 : Obtenir des coffres de clés dans un groupe de ressources

Exemple 4 : Obtenir tous les coffres de clés supprimés dans votre abonnement actuel

Exemple 5 : Obtenir un coffre de clés supprimé

Exemple 6 : Obtenir des coffres de clés à l’aide du filtrage

Paramètres

-DefaultProfile

-InRemovedState

-Location

-ResourceGroupName

-SubscriptionId

-Tag

-VaultName

Entrées

Sorties

Ressources supplémentaires

Partager via

Get-AzKeyVault

Syntaxe

Description

Exemples

Exemple 1 : Obtenir tous les coffres de clés dans votre abonnement actuel

Exemple 2 : Obtenir un coffre de clés spécifique

Exemple 3 : Obtenir des coffres de clés dans un groupe de ressources

Exemple 4 : Obtenir tous les coffres de clés supprimés dans votre abonnement actuel

Exemple 5 : Obtenir un coffre de clés supprimé

Exemple 6 : Obtenir des coffres de clés à l’aide du filtrage

Paramètres

-DefaultProfile

-InRemovedState

-Location

-ResourceGroupName

-SubscriptionId

-Tag

-VaultName

Entrées

Sorties

Liens associés

Ressources supplémentaires