Remove-AzKeyVault
Удаляет хранилище ключей.
Синтаксис
ByAvailableVault (по умолчанию)
Remove-AzKeyVault
[-VaultName] <String>
[[-ResourceGroupName] <String>]
[[-Location] <String>]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
ByDeletedVault
Remove-AzKeyVault
[-VaultName] <String>
[-Location] <String>
[-InRemovedState]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Remove-AzKeyVault
[-InputObject] <PSKeyVault>
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Remove-AzKeyVault
[-InputObject] <PSKeyVault>
[-InRemovedState]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
ResourceIdByAvailableVault
Remove-AzKeyVault
[-ResourceId] <String>
[[-Location] <String>]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
ResourceIdByDeletedVault
Remove-AzKeyVault
[-ResourceId] <String>
[-Location] <String>
[-InRemovedState]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Описание
Командлет Remove-AzKeyVault удаляет указанное хранилище ключей.
Он также удаляет все ключи и секреты, содержащиеся в этом экземпляре.
Обратите внимание, что хотя указание группы ресурсов является необязательным для этого командлета, поэтому для повышения производительности следует.
Примеры
Пример 1. Удаление хранилища ключей
Remove-AzKeyVault -VaultName "Contoso03Vault" -PassThru
True
Эта команда удаляет хранилище ключей с именем Contoso03Vault из текущей подписки.
Пример 2. Удаление хранилища ключей из указанной группы ресурсов
Remove-AzKeyVault -Name "Contoso03Vault" -ResourceGroupName "Group14" -PassThru
True
Эта команда удаляет хранилище ключей Contoso03Vault из именованной группы ресурсов.
Если имя группы ресурсов не указано, командлет ищет именованное хранилище ключей для удаления в текущей подписке.
Параметры
-AsJob
Запуск командлета в фоновом режиме
Свойства параметра
Тип: SwitchParameter
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-Confirm
Запрашивает подтверждение перед запуском cmdlet.
Свойства параметра
Тип: SwitchParameter
Default value: False
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: cf
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-DefaultProfile
Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure
Свойства параметра
Тип: IAzureContextContainer
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: AzContext, AzureRmContext, AzureCredential
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-Force
Указывает, что командлет не запрашивает подтверждение.
По умолчанию этот командлет запрашивает подтверждение удаления хранилища ключей.
Свойства параметра
Тип: SwitchParameter
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
Объект Key Vault для удаления.
Тип: PSKeyVault
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
InputObjectByAvailableVault
Position: 0
Обязательно: True
Значение из конвейера: True
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
InputObjectByDeletedVault
Position: 0
Обязательно: True
Значение из конвейера: True
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-InRemovedState
Удалите ранее удаленное хранилище окончательно.
Свойства параметра
Тип: SwitchParameter
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
ByDeletedVault
Position: Named
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
InputObjectByDeletedVault
Position: Named
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
ResourceIdByDeletedVault
Position: Named
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-Location
Расположение удаленного хранилища.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
ByAvailableVault
Position: 2
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
ResourceIdByAvailableVault
Position: 2
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-PassThru
Этот командлет по умолчанию не возвращает объект. Если этот параметр указан, он возвращает значение true в случае успешного выполнения.
Свойства параметра
Тип: SwitchParameter
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-ResourceGroupName
Указывает имя группы ресурсов.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
ByAvailableVault
Position: 1
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-ResourceId
Идентификатор ресурса KeyVault.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
ResourceIdByAvailableVault
Position: 0
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
ResourceIdByDeletedVault
Position: 0
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-SubscriptionId
Идентификатор подписки.
По умолчанию командлеты выполняются в подписке, заданной в текущем контексте. Если пользователь указывает другую подписку, текущий командлет выполняется в подписке, указанной пользователем.
Переопределение подписок действует только в течение жизненного цикла текущего командлета. Он не изменяет подписку в контексте и не влияет на последующие командлеты.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: True
Значение из оставшихся аргументов: False
-VaultName
Указывает имя хранилища ключей для удаления.
Свойства параметра
Тип: String
Default value: None
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: Имя
Наборы параметров
ByAvailableVault
Position: 0
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
ByDeletedVault
Position: 0
Обязательно: True
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
-WhatIf
Показывает, что произойдет, если командлет будет запущен.
Командлет не выполняется. Показывает, что произойдет, если командлет выполняется.
Командлет не запускается.
Свойства параметра
Тип: SwitchParameter
Default value: False
Поддерживаются подстановочные знаки: False
DontShow: False
Aliases: wi
Наборы параметров
(All)
Position: Named
Обязательно: False
Значение из конвейера: False
Значение из конвейера по имени свойства: False
Значение из оставшихся аргументов: False
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters .
Выходные данные