Skip to content

fix wording to be more clear per docs request #9327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/Storage/Storage.Management/ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
- Additional information about change #1
-->
## Upcoming Release
* Clarified description of blob immutability cmdlet
- Remove-AzRmStorageContainerImmutabilityPolicy

## Version 1.3.0
* Upgrade to Storage Client Library 10.0.1 (the namespace of all objects from this SDK change from "Microsoft.WindowsAzure.Storage.*" to "Microsoft.Azure.Storage.*")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Remove-AzRmStorageContainerImmutabilityPolicy

## SYNOPSIS
Removes ImmutabilityPolicy of a Storage blob containers
Removes ImmutabilityPolicy of a Storage blob container with an unlocked policy

## SYNTAX

Expand Down Expand Up @@ -38,42 +38,42 @@ Remove-AzRmStorageContainerImmutabilityPolicy [-InputObject] <PSImmutabilityPoli
```

## DESCRIPTION
The **Remove-AzRmStorageContainerImmutabilityPolicy** cmdlet removes ImmutabilityPolicy of a Storage blob containers.
The **Remove-AzRmStorageContainerImmutabilityPolicy** cmdlet removes ImmutabilityPolicy of a Storage blob container with an unlocked policy.

## EXAMPLES

### Example 1: Remove ImmutabilityPolicy of a Storage blob container with Storage account name and container name
### Example 1: Remove unlocked ImmutabilityPolicy of a Storage blob container with Storage account name and container name
```
PS C:\>$policy = Get-AzRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer"
PS C:\>Remove-AzRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -Etag $policy.Etag
```

This command removes ImmutabilityPolicy of a Storage blob container with Storage account name and container name.
This command removes unlocked ImmutabilityPolicy of a Storage blob container with Storage account name and container name.

### Example 2: Remove ImmutabilityPolicy of a Storage blob container, with Storage account object
### Example 2: Remove unlocked ImmutabilityPolicy of a Storage blob container, with Storage account object
```
PS C:\>$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount"
PS C:\>$policy = Get-AzRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer"
PS C:\>Remove-AzRmStorageContainerImmutabilityPolicy -StorageAccount $accountObject -ContainerName "myContainer" -Etag $policy.Etag
```

This command removes ImmutabilityPolicy of a Storage blob container, with Storage account object.
This command removes unlocked ImmutabilityPolicy of a Storage blob container, with Storage account object.

### Example 3: Remove ImmutabilityPolicyof a Storage blob container, with container object
### Example 3: Remove unlocked ImmutabilityPolicy of a Storage blob container, with container object
```
PS C:\>$containerObject = Get-AzStorageContainer -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -Name "myContainer"
PS C:\>$policy = Get-AzRmStorageContainerImmutabilityPolicy -Container $containerObject
PS C:\>Remove-AzRmStorageContainerImmutabilityPolicy -Container $containerObject -Etag $policy.Etag
```

This command removes ImmutabilityPolicy of a Storage blob container with Storage container object.
This command removes unlocked ImmutabilityPolicy of a Storage blob container with Storage container object.

### Example 4: Remove ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object
### Example 4: Remove unlocked ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object
```
PS C:\>Get-AzRmStorageContainerImmutabilityPolicy -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" | Remove-AzRmStorageContainerImmutabilityPolicy
```

This command removes ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object.
This command removes unlocked ImmutabilityPolicy of a Storage blob container, with ImmutabilityPolicy object.

## PARAMETERS

Expand Down Expand Up @@ -138,7 +138,7 @@ Accept wildcard characters: False
```

### -InputObject
ImmutabilityPolicy Object to Remove
Unlocked ImmutabilityPolicy Object to Remove

```yaml
Type: Microsoft.Azure.Commands.Management.Storage.Models.PSImmutabilityPolicy
Expand Down