Remove-AzureKeyVaultKey
Удаляет ключ в хранилище ключей.
Предупреждение
Модуль AzureRM PowerShell официально устарел с 29 февраля 2024 г. Пользователям рекомендуется выполнить миграцию из AzureRM в модуль Az PowerShell, чтобы обеспечить постоянную поддержку и обновления.
Хотя модуль AzureRM по-прежнему может функционировать, он больше не поддерживается или не поддерживается, размещая любое постоянное использование на усмотрение и риск пользователя. Ознакомьтесь с нашими ресурсами миграции, чтобы получить рекомендации по переходу в модуль Az.
Синтаксис
Remove-AzureKeyVaultKey
[-VaultName] <String>
[-Name] <String>
[-Force]
[-PassThru]
[-InRemovedState]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzureKeyVaultKey
[-InputObject] <PSKeyVaultKeyIdentityItem>
[-Force]
[-PassThru]
[-InRemovedState]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Описание
Командлет Remove-AzureKeyVaultKey удаляет ключ в хранилище ключей. Если ключ был случайно удален, его можно восстановить с помощью undo-AzureKeyVaultKeyRemoval пользователем с специальными разрешениями восстановления. Этот командлет имеет значение высокого уровня для свойства ConfirmImpact .
Примеры
Пример 1. Удаление ключа из хранилища ключей
PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -PassThru
Vault Name : contoso
Name : key2
Id : https://contoso.vault.azure.net:443/keys/itsoftware/fdad15793ba0437e960497908ef9eb32
Deleted Date : 5/24/2018 11:28:25 PM
Scheduled Purge Date : 8/22/2018 11:28:25 PM
Enabled : False
Expires : 10/11/2018 11:32:49 PM
Not Before : 4/11/2018 11:22:49 PM
Created : 4/12/2018 10:16:38 PM
Updated : 4/12/2018 10:16:38 PM
Purge Disabled : False
Tags :
Эта команда удаляет ключ с именем ITSoftware из хранилища ключей contoso.
Пример 2. Удаление ключа без подтверждения пользователя
PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Force
Эта команда удаляет ключ с именем ITSoftware из хранилища ключей contoso. Команда задает параметр Force , поэтому командлет не запрашивает подтверждение.
Пример 3. Очистка удаленного ключа из хранилища ключей окончательно
PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -InRemovedState
Эта команда удаляет ключ с именем ITSoftware из хранилища ключей с именем Contoso безвозвратно. Для выполнения этого командлета требуется разрешение "очистка", которое должно быть ранее и явно предоставлено пользователю для этого хранилища ключей.
Пример 4. Удаление ключей с помощью оператора конвейера
PS C:\> Get-AzureKeyVaultKey -VaultName 'Contoso' | Where-Object {$_.Attributes.Enabled -eq $False} | Remove-AzureKeyVaultKey
Эта команда получает все ключи в хранилище ключей с именем Contoso и передает их командлету Where-Object с помощью оператора конвейера. Этот командлет передает ключи, имеющие значение $False для атрибута Enabled в текущий командлет. Этот командлет удаляет эти ключи.
Параметры
-Confirm
Запрос подтверждения перед выполнением командлета.
Тип: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-DefaultProfile
Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure
Тип: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Force
Принудительное выполнение команды без запроса на подтверждение пользователем.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-InputObject
Объект KeyBundle
Тип: | PSKeyVaultKeyIdentityItem |
Position: | 0 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-InRemovedState
Удалите ранее удаленный ключ окончательно.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Name
Указывает имя ключа для удаления. Этот командлет создает полное доменное имя ключа (FQDN) на основе имени, указанного этим параметром, имени хранилища ключей и текущей среды.
Тип: | String |
Aliases: | KeyName |
Position: | 1 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-PassThru
Указывает, что этот командлет возвращает объект Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey. По умолчанию этот командлет не создает выходные данные.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-VaultName
Указывает имя хранилища ключей, из которого необходимо удалить ключ. Этот командлет создает полное доменное имя хранилища ключей на основе имени, указанного этим параметром, и текущей среды.
Тип: | String |
Position: | 0 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-WhatIf
Показывает, что произойдет при запуске командлета. Командлет не выполняется. Показывает, что произойдет, если командлет выполняется. Командлет не выполняется.
Тип: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
Входные данные
Параметры: InputObject (ByValue)