Get-AzKeyVault

Модуль:: Az.KeyVault Module

Возвращает хранилища ключей.

Синтаксис

GetVaultByName (по умолчанию)

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

ByDeletedVault

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

ListAllDeletedVaultsInSubscription

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

Описание

Командлет Get-AzKeyVault получает сведения о хранилищах ключей в подписке. Вы можете просмотреть все экземпляры хранилищ ключей в подписке или отфильтровать результаты по группе ресурсов или определенному хранилищу ключей. Обратите внимание, что хотя указание группы ресурсов является необязательным для этого командлета при получении одного хранилища ключей, это необходимо сделать для повышения производительности.

Командлет может вызвать ниже API Microsoft Graph в соответствии с входным параметрами:

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

Примеры

Пример 1. Получение всех хранилищ ключей в текущей подписке

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                :

Эта команда получает все хранилища ключей в текущей подписке.

Пример 2. Получение определенного хранилища ключей

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 ([email protected])
                                   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                             :

Эта команда получает хранилище ключей с именем myvault в текущей подписке.

Пример 3. Получение хранилищ ключей в группе ресурсов

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                :

Эта команда получает все хранилища ключей в группе ресурсов с именем ContosoPayRollResourceGroup.

Пример 4. Получение всех удаленных хранилищ ключей в текущей подписке

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                 :

Эта команда получает все удаленные хранилища ключей в текущей подписке.

Пример 5. Получение удаленного хранилища ключей

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                 :

Эта команда получает удаленные сведения хранилища ключей с именем myvault4 в текущей подписке и в регионе westus.

Пример 6. Получение хранилищ ключей с помощью фильтрации

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                :

Эта команда получает все хранилища ключей в подписке, начинающиеся с myvault.

Параметры

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure

Свойства параметра

Тип:	IAzureContextContainer
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-InRemovedState

Указывает, следует ли отображать ранее удаленные хранилища в выходных данных.

Свойства параметра

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

ByDeletedVault

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

ListAllDeletedVaultsInSubscription

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Location

Расположение удаленного хранилища.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

ByDeletedVault

Position:	1
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-ResourceGroupName

Указывает имя группы ресурсов, связанной с хранилищем ключей или хранилищами ключей, запрашиваемых.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	True
DontShow:	False

Наборы параметров

GetVaultByName

Position:	1
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-SubscriptionId

Идентификатор подписки. По умолчанию командлеты выполняются в подписке, заданной в текущем контексте. Если пользователь указывает другую подписку, текущий командлет выполняется в подписке, указанной пользователем. Переопределение подписок действует только в течение жизненного цикла текущего командлета. Он не изменяет подписку в контексте и не влияет на последующие командлеты.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-Tag

Пары "ключ-значение" в виде хэш-таблицы. Например: @{key0="value0"; key1=$null; key2="value2"}

Свойства параметра

Тип:	Hashtable
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

GetVaultByName

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-VaultName

Указывает имя хранилища ключей.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	True
DontShow:	False
Aliases:	Имя

Наборы параметров

GetVaultByName

Position:	0
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Входные данные

String

Hashtable

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через

Get-AzKeyVault

Синтаксис

GetVaultByName (по умолчанию)

ByDeletedVault

ListAllDeletedVaultsInSubscription

Описание

Примеры

Пример 1. Получение всех хранилищ ключей в текущей подписке

Пример 2. Получение определенного хранилища ключей

Пример 3. Получение хранилищ ключей в группе ресурсов

Пример 4. Получение всех удаленных хранилищ ключей в текущей подписке

Пример 5. Получение удаленного хранилища ключей

Пример 6. Получение хранилищ ключей с помощью фильтрации

Параметры

-DefaultProfile

Свойства параметра

Наборы параметров

-InRemovedState

Свойства параметра

Наборы параметров

-Location

Свойства параметра

Наборы параметров

-ResourceGroupName

Свойства параметра

Наборы параметров

-SubscriptionId

Свойства параметра

Наборы параметров

-Tag

Свойства параметра

Наборы параметров

-VaultName

Свойства параметра

Наборы параметров

CommonParameters

Входные данные

String

Hashtable

Выходные данные

PSKeyVault

PSKeyVaultIdentityItem

PSDeletedKeyVault

Связанные ссылки

Обратная связь