Skip to content

Commit d6ba47d

Browse files
authored
[Storage] Fix help file format per static analysis result (Azure#20774)
* fix help * update formatting * format help examples * Update help example format * Fix example cmdlet usage * Add skip line * remove skip comment * Fix exmaple title typo by comments
1 parent c663ad8 commit d6ba47d

File tree

143 files changed

+894
-909
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

143 files changed

+894
-909
lines changed

src/Storage/Storage.Management/help/Add-AzRmStorageContainerLegalHold.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,23 +39,23 @@ The **Add-AzRmStorageContainerLegalHold** cmdlet adds legal hold tags to a Stora
3939
## EXAMPLES
4040

4141
### Example 1: Add legal hold tags to a Storage blob container with Storage account name and container name
42-
```
43-
PS C:\>Add-AzRmStorageContainerLegalHold -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -Tag tag1,tag2 -AllowProtectedAppendWriteAll $true
42+
```powershell
43+
Add-AzRmStorageContainerLegalHold -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" -ContainerName "myContainer" -Tag tag1,tag2 -AllowProtectedAppendWriteAll $true
4444
```
4545

4646
This command adds legal hold tags to a Storage blob container with Storage account name and container name, and set AllowProtectedAppendWriteAll as true to allow append new blocks to append or block blob.
4747

4848
### Example 2: Add legal hold tags to a Storage blob container with Storage account object and container name
49-
```
50-
PS C:\>$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount"
51-
PS C:\>Add-AzRmStorageContainerLegalHold -StorageAccount $accountObject -ContainerName "myContainer" -Tag tag1
49+
```powershell
50+
$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount"
51+
Add-AzRmStorageContainerLegalHold -StorageAccount $accountObject -ContainerName "myContainer" -Tag tag1
5252
```
5353

5454
This command adds legal hold tags to a Storage blob container with Storage account object and container name.
5555

5656
### Example 3: Add legal hold tags to all Storage blob containers in a Storage account with pipeline
57-
```
58-
PS C:\>Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" | Add-AzRmStorageContainerLegalHold -Tag tag1,tag2,tag3
57+
```powershell
58+
Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -AccountName "myStorageAccount" | Add-AzRmStorageContainerLegalHold -Tag tag1,tag2,tag3
5959
```
6060

6161
This command adds legal hold tags to all Storage blob containers in a Storage account with pipeline.

src/Storage/Storage.Management/help/Add-AzStorageAccountNetworkRule.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -58,45 +58,45 @@ The **Add-AzStorageAccountNetworkRule** cmdlet adds IpRules or VirtualNetworkRul
5858
## EXAMPLES
5959

6060
### Example 1: Add several IpRules with IPAddressOrRange
61-
```
62-
PS C:\>Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -IPAddressOrRange "10.0.0.0/7","28.2.0.0/16"
61+
```powershell
62+
Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -IPAddressOrRange "10.0.0.0/7","28.2.0.0/16"
6363
```
6464

6565
This command add several IpRules with IPAddressOrRange.
6666

6767
### Example 2: Add a VirtualNetworkRule with VirtualNetworkResourceID
68-
```
69-
PS C:\>$subnet = Get-AzVirtualNetwork -ResourceGroupName "myResourceGroup" -Name "myvirtualnetwork" | Get-AzVirtualNetworkSubnetConfig
70-
PS C:\>Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -VirtualNetworkResourceId $subnet[0].Id
68+
```powershell
69+
$subnet = Get-AzVirtualNetwork -ResourceGroupName "myResourceGroup" -Name "myvirtualnetwork" | Get-AzVirtualNetworkSubnetConfig
70+
Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -VirtualNetworkResourceId $subnet[0].Id
7171
```
7272

7373
This command add a VirtualNetworkRule with VirtualNetworkResourceID.
7474

7575
### Example 3: Add VirtualNetworkRules with VirtualNetworkRule Objects from another account
76-
```
77-
PS C:\> $networkrule = Get-AzStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount1"
78-
PS C:\> Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount2" -VirtualNetworkRule $networkrule.VirtualNetworkRules
76+
```powershell
77+
$networkrule = Get-AzStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount1"
78+
Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount2" -VirtualNetworkRule $networkrule.VirtualNetworkRules
7979
```
8080

8181
This command add VirtualNetworkRules with VirtualNetworkRule Objects from another account.
8282

8383
### Example 4: Add several IpRule with IpRule objects, input with JSON
84-
```
85-
PS C:\>Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -IPRule (@{IPAddressOrRange="10.0.0.0/7";Action="allow"},@{IPAddressOrRange="28.2.0.0/16";Action="allow"})
84+
```powershell
85+
Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -IPRule (@{IPAddressOrRange="10.0.0.0/7";Action="allow"},@{IPAddressOrRange="28.2.0.0/16";Action="allow"})
8686
```
8787

8888
This command add several IpRule with IpRule objects, input with JSON.
8989

9090
### Example 5: Add a resource access rule
91-
```
92-
PS C:\>Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -TenantId $tenantId -ResourceId $ResourceId
91+
```powershell
92+
Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount" -TenantId $tenantId -ResourceId $ResourceId
9393
```
9494

9595
This command adds a resource access rule with TenantId and ResourceId.
9696

9797
### Example 6: Add all resource access rules of one storage account to another storage account
98-
```
99-
PS C:\> (Get-AzStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount1").ResourceAccessRules | Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount2"
98+
```powershell
99+
(Get-AzStorageAccountNetworkRuleSet -ResourceGroupName "myResourceGroup" -Name "mystorageaccount1").ResourceAccessRules | Add-AzStorageAccountNetworkRule -ResourceGroupName "myResourceGroup" -Name "mystorageaccount2"
100100
```
101101

102102
This command gets all resource access rules from one storage account, and adds them to another storage account.

src/Storage/Storage.Management/help/Close-AzStorageFileHandle.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,31 +66,32 @@ The **Close-AzStorageFileHandle** cmdlet closes file handles of a file share, o
6666
## EXAMPLES
6767

6868
### Example 1: Close all file handles on a file
69-
```
70-
PS C:\> Close-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2/test.txt' -CloseAll
69+
```powershell
70+
Close-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2/test.txt' -CloseAll
7171
```
7272

7373
This command closes all file handles on a file.
7474

7575
### Example 2: Close all file handles which is opened 1 day ago on a file directory
76-
```
77-
PS C:\> Get-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2' -Recursive | Where-Object {$_.OpenTime.DateTime.AddDays(1) -lt (Get-Date)} | Close-AzStorageFileHandle -ShareName "mysharename"
76+
```powershell
77+
Get-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2' -Recursive | Where-Object {$_.OpenTime.DateTime.AddDays(1) -lt (Get-Date)} | Close-AzStorageFileHandle -ShareName "mysharename"
7878
```
7979

8080
This command lists all file handles on a file directory recursively, filters out the handles which are opened 1 day ago, and then closes them.
8181

8282
### Example 3: Close all file handles on a file directory recursively and show the closed file handle count
83-
<!-- Skip: Output cannot be splitted from code -->
83+
```powershell
84+
Close-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2' -Recursive -CloseAll -PassThru
8485
```
85-
PS C:\> Close-AzStorageFileHandle -ShareName "mysharename" -Path 'dir1/dir2' -Recursive -CloseAll -PassThru
86+
```output
8687
10
8788
```
8889

8990
This command closes all file handles on a file directory and shows the closed file handle count.
9091

9192
### Example 4: Close all file handles on a file share
92-
```
93-
PS C:\> Close-AzStorageFileHandle -ShareName "mysharename" -CloseAll -Recursive
93+
```powershell
94+
Close-AzStorageFileHandle -ShareName "mysharename" -CloseAll -Recursive
9495
```
9596

9697
This command closes all file handles on a specific file share recursively.

src/Storage/Storage.Management/help/Copy-AzStorageBlob.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,37 +42,37 @@ The **Copy-AzStorageBlob** cmdlet copies a blob synchronously, currently only su
4242
## EXAMPLES
4343

4444
### Example 1: Copy a named blob to another
45-
```
45+
```powershell
4646
$destBlob = Copy-AzStorageBlob -SrcContainer "sourcecontainername" -SrcBlob "srcblobname" -DestContainer "destcontainername" -DestBlob "destblobname"
4747
```
4848

4949
This command copies a blob from source container to the destination container with a new blob name.
5050

5151
### Example 2: Copy blob from a blob object
52-
```
52+
```powershell
5353
$srcBlob = Get-AzStorageBlob -Container $containerName -Blob $blobName -Context $ctx
5454
$destBlob = $srcBlob | Copy-AzStorageBlob -DestContainer "destcontainername" -DestBlob "destblobname"
5555
```
5656

5757
This command copies a blob from source blob object to the destination container with a new blob name.
5858

5959
### Example 3: Copy blob from a blob Uri
60-
```
60+
```powershell
6161
$srcBlobUri = New-AzStorageBlobSASToken -Container $srcContainerName -Blob $srcBlobName -Permission rt -ExpiryTime (Get-Date).AddDays(7) -FullUri
6262
$destBlob = Copy-AzStorageBlob -AbsoluteUri $srcBlobUri -DestContainer "destcontainername" -DestBlob "destblobname"
6363
```
6464

6565
The first command creates a blob Uri of the source blob, with sas token of permission "rt". The second command copies from source blob Uri to the destination blob.
6666

6767
### Example 4: Update a block blob encryption scope
68-
```
68+
```powershell
6969
$blob = Copy-AzStorageBlob -SrcContainer $containerName -SrcBlob $blobname -DestContainer $containername -EncryptionScope $newScopeName -Force
7070
```
7171

7272
This command update a block blob encryption scope by copy it to itself with a new encryption scope.
7373

7474
### Example 5: Copy a blob to a new append blob
75-
```
75+
```powershell
7676
$srcBlob = Get-AzStorageBlob -Container $containerName -Blob $blobName -Context $ctx
7777
$destBlob = Copy-AzStorageBlob -SrcContainer "sourcecontainername" -SrcBlob "srcblobname" -DestContainer "destcontainername" -DestBlob "destblobname" -DestBlobType "Append" -DestContext $destCtx
7878
```

src/Storage/Storage.Management/help/Disable-AzStorageBlobDeleteRetentionPolicy.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ The **Disable-AzStorageBlobDeleteRetentionPolicy** cmdlet disables delete retent
3535

3636
## EXAMPLES
3737

38-
### Example 1: Disable delete retention policy for the Blob service
39-
<!-- Skip: Output cannot be splitted from code -->
38+
### Example 1: Disable delete retention policy for the Blob services
39+
```powershell
40+
Disable-AzStorageBlobDeleteRetentionPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -PassThru
4041
```
41-
C:\PS>Disable-AzStorageBlobDeleteRetentionPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -PassThru
42-
42+
```output
4343
Enabled Days
4444
------- ----
4545
False

src/Storage/Storage.Management/help/Disable-AzStorageBlobLastAccessTimeTracking.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ The **Disable-AzStorageBlobDeleteRetentionPolicy** cmdlet disables delete retent
3030
## EXAMPLES
3131

3232
### Example 1: Disable last access time tracking for the Blob service
33-
```
34-
C:\PS>Disable-AzStorageBlobLastAccessTimeTracking -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount"
33+
```powershell
34+
Disable-AzStorageBlobLastAccessTimeTracking -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount"
3535
```
3636

3737
This command disables last access time tracking for the Blob service.

src/Storage/Storage.Management/help/Disable-AzStorageBlobRestorePolicy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The **Disable-AzStorageBlobRestorePolicy** cmdlet disables Blob Restore Policy f
3737

3838
### Example 1: Disables Blob Restore Policy for the Azure Storage Blob service on a Storage account
3939
```powershell
40-
PS C:\> Disable-AzStorageBlobRestorePolicy -ResourceGroupName "myresourcegoup" -StorageAccountName "mystorageaccount"
40+
Disable-AzStorageBlobRestorePolicy -ResourceGroupName "myresourcegoup" -StorageAccountName "mystorageaccount"
4141
```
4242

4343
This command Disables Blob Restore Policy for the Azure Storage Blob service on a Storage account.

src/Storage/Storage.Management/help/Disable-AzStorageContainerDeleteRetentionPolicy.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,11 @@ The **Disable-AzStorageContainerDeleteRetentionPolicy** cmdlet disables delete r
3636
## EXAMPLES
3737

3838
### Example 1: Disable delete retention policy for blob containers
39-
<!-- Skip: Output cannot be splitted from code -->
39+
```powershell
40+
Disable-AzStorageContainerDeleteRetentionPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -PassThru
4041
```
41-
C:\PS>Disable-AzStorageContainerDeleteRetentionPolicy -ResourceGroupName "myresourcegroup" -AccountName "mystorageaccount" -PassThru
4242

43+
```output
4344
Enabled Days
4445
------- ----
4546
False

src/Storage/Storage.Management/help/Disable-AzStorageDeleteRetentionPolicy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ The **Disable-AzStorageDeleteRetentionPolicy** cmdlet disables delete retention
2323
## EXAMPLES
2424

2525
### Example 1: Disable delete retention policy for the Blob service
26-
```
27-
C:\PS>Disable-AzStorageDeleteRetentionPolicy
26+
```powershell
27+
Disable-AzStorageDeleteRetentionPolicy
2828
```
2929

3030
This command disables delete retention policy for the Blob service.

src/Storage/Storage.Management/help/Disable-AzStorageStaticWebsite.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ The **Disable-AzStorageStaticWebsite** cmdlet disables static website for the Az
2323
## EXAMPLES
2424

2525
### Example 1: Disable static website for a Azure Storage account
26-
```
27-
C:\PS>Disable-AzStorageStaticWebsite
26+
```powershell
27+
Disable-AzStorageStaticWebsite
2828
```
2929

3030
This command disables static website for a Azure Storage account.

0 commit comments

Comments
 (0)