Remove-AzKeyVaultManagedStorageSasDefinition
Removes a Key Vault managed Azure Storage SAS definitions.
Syntax
Remove-AzKeyVaultManagedStorageSasDefinition
[-VaultName] <String>
[-AccountName] <String>
[-Name] <String>
[-Force]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzKeyVaultManagedStorageSasDefinition
[-InputObject] <PSKeyVaultManagedStorageSasDefinitionIdentityItem>
[-Force]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Removes a Key Vault managed Azure Storage SAS definitions. This also removes the secret used to get the SAS token per this SAS definition.
Examples
Example 1: Remove a Key Vault managed Azure Storage SAS definition.
Remove-AzKeyVaultManagedStorageSasDefinition -VaultName 'myvault' -AccountName 'mystorageaccount' -Name 'mysasdef' -PassThru
Id : https://myvault.vault.azure.net:443/storage/mystorageaccount/sas/mysasdef
Vault Name : myvault
AccountName : mystorageaccount
Name : mysasdef
Enabled : True
Created : 5/24/2018 9:11:08 PM
Updated : 5/24/2018 9:11:08 PM
Tags :
Removes a Key Vault managed Storage SAS definition 'mysasdef' associated with the account 'mystorageaccount' in vault 'myvault'.
Example 2: Remove a Key Vault managed Azure Storage SAS definition without user confirmation.
Remove-AzKeyVaultManagedStorageSasDefinition -VaultName 'myvault' -AccountName 'mystorageaccount' -Name 'mysasdef' -PassThru -Force
Id : https://myvault.vault.azure.net:443/storage/mystorageaccount/sas/mysasdef
Vault Name : myvault
AccountName : mystorageaccount
Name : mysasdef
Enabled : True
Created : 5/24/2018 9:11:08 PM
Updated : 5/24/2018 9:11:08 PM
Tags :
Removes a Key Vault managed Storage SAS definition 'mysasdef' associated with the account 'mystorageaccount' in vault 'myvault'.
Parameters
-AccountName
Storage account name. Cmdlet constructs the FQDN of a managed storage account name from vault name, currently selected environment and storage account name.
Type: | String |
Aliases: | StorageAccountName |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Do not ask for confirmation.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
ManagedStorageSasDefinition object.
Type: | PSKeyVaultManagedStorageSasDefinitionIdentityItem |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Storage sas definition name. Cmdlet constructs the FQDN of a storage sas definition from vault name, currently selected environment, storage account name and sas definition name.
Type: | String |
Aliases: | SasDefinitionName |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Cmdlet does not return an object by default. If this switch is specified, cmdlet returns the managed storage account that was deleted.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VaultName
Vault name. Cmdlet constructs the FQDN of a vault based on the name and currently selected environment.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
PSKeyVaultManagedStorageSasDefinitionIdentityItem
Outputs
PSDeletedKeyVaultManagedStorageSasDefinition
Related Links
Azure PowerShell