Skip to content

Commit 89262bc

Browse files
committed
revise storage cmdlets help since help change.
1 parent dfa41e1 commit 89262bc

15 files changed

+41
-33
lines changed

src/ResourceManager/Storage/Commands.Management.Storage/help/Set-AzureRmStorageAccount.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,13 @@ PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountNa
5555

5656
The command sets the Access Tier value to be cool.
5757

58+
### Example 4: Set the custom domain and tags
59+
```
60+
PS C:\>Set-AzureRmStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "MyStorageAccount" -CustomDomainName "www.domainname.com" –UseSubDomain $true -Tag @{tag0="value0";tag1="value1";tag2="value2"}
61+
```
62+
63+
The command sets the Access Tier value to be cool.
64+
5865
## PARAMETERS
5966

6067
### -ResourceGroupName

src/Storage/Commands.Storage/help/Azure.Storage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,10 @@ Lists the storage tables.
6363
Gets the stored access policy or policies for an Azure storage table.
6464

6565
### [New-AzureStorageAccountSASToken](New-AzureStorageAccountSASToken.md)
66-
Creates an SAS token.
66+
Creates an account-level SAS token.
6767

6868
### [New-AzureStorageBlobSASToken](New-AzureStorageBlobSASToken.md)
69-
Generates an SAS token for an Azure storage blob.
69+
Generates a SAS token for an Azure storage blob.
7070

7171
### [New-AzureStorageContainer](New-AzureStorageContainer.md)
7272
Creates an Azure storage container.

src/Storage/Commands.Storage/help/Get-AzureStorageFileContent.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,13 @@ PS C:\>Get-AzureStorageFileContent -ShareName "ContosoShare06" -Path "ContosoWor
5353

5454
This command downloads a file that is named CurrentDataFile in the folder ContosoWorkingFolder from the file share ContosoShare06 to current folder.
5555

56+
### Example 2: Downloads the files under sample file share
57+
```
58+
PS C:\>Get-AzureStorageFile -ShareName sample | ? {$_.GetType().Name -eq "CloudFile"} | Get-AzureStorageFileContent
59+
```
60+
61+
This example downloads the files under sample file share
62+
5663
## PARAMETERS
5764

5865
### -CheckMd5

src/Storage/Commands.Storage/help/New-AzureStorageAccountSASToken.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-AzureStorageAccountSASToken
99

1010
## SYNOPSIS
11-
Creates an SAS token.
11+
Creates an account-level SAS token.
1212

1313
## SYNTAX
1414

@@ -26,19 +26,19 @@ You can use the SAS token to delegate permissions for multiple services, or to d
2626

2727
## EXAMPLES
2828

29-
### Example 1: Create an SAS token
29+
### Example 1: Create an account-level SAS token with full permission
3030
```
3131
PS C:\> New-AzureStorageAccountSASToken -Service Blob,File,Table,Queue -ResourceType Service,Container,Object -Permission "racwdlup"
3232
```
3333

3434
This command creates an account-level SAS token with full permission.
3535

36-
### Example 2: Create an SAS token for a range of IP addresses
36+
### Example 2: Create an account-level SAS token for a range of IP addresses
3737
```
3838
PS C:\> New-AzureStorageAccountSASToken -Service Blob,File,Table,Queue -ResourceType Service,Container,Object -Permission "racwdlup" -Protocol HttpsOnly -IPAddressOrRange 168.1.5.60-168.1.5.70
3939
```
4040

41-
This command creates an SAS token for HTTPS-only requests from the specified range of IP addresses.
41+
This command creates an account-level SAS token for HTTPS-only requests from the specified range of IP addresses.
4242

4343
## PARAMETERS
4444

src/Storage/Commands.Storage/help/New-AzureStorageBlobSASToken.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-AzureStorageBlobSASToken
99

1010
## SYNOPSIS
11-
Generates an SAS token for an Azure storage blob.
11+
Generates a SAS token for an Azure storage blob.
1212

1313
## SYNTAX
1414

src/Storage/Commands.Storage/help/New-AzureStorageContainerStoredAccessPolicy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Accept wildcard characters: False
116116
```
117117
118118
### -Permission
119-
Specifies the level of public access to this container.
119+
Specifies permissions in the stored access policy to access the container.
120120
121121
```yaml
122122
Type: String

src/Storage/Commands.Storage/help/New-AzureStorageContext.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -236,13 +236,7 @@ Accept wildcard characters: False
236236
```
237237

238238
### -Protocol
239-
Specifies the protocol permitted for a request made with the account SAS.
240-
The acceptable values for this parameter are:
241-
242-
- HttpsOnly
243-
- HttpsOrHttp
244-
245-
The default value is HttpsOrHttp.
239+
Transfer Protocol (https/http).
246240

247241
```yaml
248242
Type: String

src/Storage/Commands.Storage/help/New-AzureStorageQueueStoredAccessPolicy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Accept wildcard characters: False
6363
```
6464
6565
### -Permission
66-
Specifies the level of public access to this storage queue.
66+
Specifies permissions in the stored access policy to access the storage queue.
6767
6868
```yaml
6969
Type: String
@@ -78,7 +78,7 @@ Accept wildcard characters: False
7878
```
7979
8080
### -Policy
81-
Specifies a stored access policy, which includes the permissions for this SAS token.
81+
Specifies a name for the stored access policy.
8282
8383
```yaml
8484
Type: String

src/Storage/Commands.Storage/help/New-AzureStorageTableStoredAccessPolicy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Accept wildcard characters: False
6363
```
6464
6565
### -Permission
66-
Specifies the level of public access to this storage table.
66+
Specifies permissions in the stored access policy to access the storage table.
6767
6868
```yaml
6969
Type: String
@@ -78,7 +78,7 @@ Accept wildcard characters: False
7878
```
7979
8080
### -Policy
81-
Specifies a stored access policy, which includes the permissions for this Shared Access Signature (SAS) token.
81+
Specifies a name for the stored access policy.
8282
8383
```yaml
8484
Type: String

src/Storage/Commands.Storage/help/Remove-AzureStorageContainerStoredAccessPolicy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Accept wildcard characters: False
116116
```
117117
118118
### -Policy
119-
Specifies the stored access policy, which includes the permissions for this SAS token.
119+
Specifies the name of the stored access policy that this cmdlet removes.
120120
121121
```yaml
122122
Type: String

src/Storage/Commands.Storage/help/Remove-AzureStorageQueueStoredAccessPolicy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Accept wildcard characters: False
6464
```
6565
6666
### -Policy
67-
Specifies the stored access policy, which includes the permissions for this Shared Access Signature (SAS) token.
67+
Specifies the name of the stored access policy that this cmdlet removes.
6868
6969
```yaml
7070
Type: String

src/Storage/Commands.Storage/help/Remove-AzureStorageTableStoredAccessPolicy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Accept wildcard characters: False
6464
```
6565
6666
### -Policy
67-
Specifies the stored access policy, which includes the permissions for this SAS token.
67+
Specifies the name of the stored access policy that this cmdlet removes.
6868
6969
```yaml
7070
Type: String

src/Storage/Commands.Storage/help/Set-AzureStorageContainerStoredAccessPolicy.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ The **Set-AzureStorageContainerStoredAccessPolicy** cmdlet sets a stored access
2424

2525
## EXAMPLES
2626

27-
### Example 1: Set a stored access policy in a storage container
27+
### Example 1: Set a stored access policy in a storage container with full permission
2828
```
29-
PS C:\>Set-AzureStorageContainerStoredAccessPolicy -Container "MyContainer" -Policy "Policy06"
29+
PS C:\>Set-AzureStorageContainerStoredAccessPolicy -Container "MyContainer" -Policy "Policy06" -Permission rwdl
3030
```
3131

3232
This command sets an access policy named Policy06 for storage container named MyContainer.
@@ -146,7 +146,7 @@ Accept wildcard characters: False
146146
```
147147
148148
### -Permission
149-
Specifies the level of public access to this container.
149+
Specifies permissions in the stored access policy to access the storage container.
150150
151151
```yaml
152152
Type: String
@@ -161,7 +161,7 @@ Accept wildcard characters: False
161161
```
162162
163163
### -Policy
164-
Specifies a stored access policy, which includes the permissions for this Shared Access Signature (SAS) token.
164+
Specifies the name for the stored access policy.
165165
166166
```yaml
167167
Type: String

src/Storage/Commands.Storage/help/Set-AzureStorageQueueStoredAccessPolicy.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ The **Set-AzureStorageQueueStoredAccessPolicy** cmdlet sets a stored access poli
2323

2424
## EXAMPLES
2525

26-
### Example 1: Set a stored access policy in the queue
26+
### Example 1: Set a stored access policy in the queue with full permission
2727
```
28-
PS C:\> Set-AzureStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy07"
28+
PS C:\> Set-AzureStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy07" -Permission arup
2929
```
3030

3131
This command sets an access policy named Policy07 for storage queue named MyQueue.
@@ -94,7 +94,7 @@ Accept wildcard characters: False
9494
```
9595
9696
### -Permission
97-
Specifies the level of public access to this storage queue.
97+
Specifies permissions in the stored access policy to access the storage queue.
9898
9999
```yaml
100100
Type: String
@@ -109,7 +109,7 @@ Accept wildcard characters: False
109109
```
110110
111111
### -Policy
112-
Specifies a stored access policy, which includes the permissions for this SAS token.
112+
Specifies the name for the stored access policy.
113113
114114
```yaml
115115
Type: String

src/Storage/Commands.Storage/help/Set-AzureStorageTableStoredAccessPolicy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The **Set-AzureStorageTableStoredAccessPolicy** cmdlet set the stored access pol
2525

2626
### Example 1: Set a stored access policy in table with full permission
2727
```
28-
PS C:\>Set-AzureStorageTableStoredAccessPolicy -Table "MyTable" -Policy "Policy08"
28+
PS C:\>Set-AzureStorageTableStoredAccessPolicy -Table "MyTable" -Policy "Policy08" -Permission raud
2929
```
3030

3131
This command sets an access policy named Policy08 for storage table named MyTable.
@@ -94,7 +94,7 @@ Accept wildcard characters: False
9494
```
9595
9696
### -Permission
97-
Specifies the level of public access to this storage table.
97+
Specifies permissions in the stored access policy to access the storage table.
9898
9999
```yaml
100100
Type: String
@@ -109,7 +109,7 @@ Accept wildcard characters: False
109109
```
110110
111111
### -Policy
112-
Specifies a stored access policy, which includes the permissions for this SAS token.
112+
Specifies the name for the stored access policy.
113113
114114
```yaml
115115
Type: String

0 commit comments

Comments
 (0)