Skip to content

Commit 0ed3111

Browse files
cormacpaynecormacpayne
authored
Merge pull request Azure#3989 from wastoresh/fixhelp
Update storage help
2 parents 8c7441d + e87bc1c commit 0ed3111

File tree

65 files changed

+198
-199
lines changed

Some content is hidden

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

65 files changed

+198
-199
lines changed

‎src/Storage/Commands.Storage/Blob/Cmdlet/GetAzureStorageBlob.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ public class GetAzureStorageBlobCommand : StorageCloudBlobCmdletBase
4242
private const string PrefixParameterSet = "BlobPrefix";
4343

4444
[Parameter(Position = 0, HelpMessage = "Blob name", ParameterSetName = NameParameterSet)]
45+
[SupportsWildcards()]
4546
public string Blob
4647
{
4748
get

‎src/Storage/Commands.Storage/Blob/Cmdlet/GetAzureStorageContainer.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ public class GetAzureStorageContainerCommand : StorageCloudBlobCmdletBase
4747
ValueFromPipeline = true,
4848
ValueFromPipelineByPropertyName = true,
4949
ParameterSetName = NameParameterSet)]
50+
[SupportsWildcards()]
5051
public string Name { get; set; }
5152

5253
[Parameter(HelpMessage = "Container Prefix",

‎src/Storage/Commands.Storage/Queue/Cmdlet/GetAzureStorageQueue.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ public class GetAzureStorageQueueCommand : StorageQueueBaseCmdlet
4646
ValueFromPipeline = true,
4747
ValueFromPipelineByPropertyName = true,
4848
ParameterSetName = NameParameterSet)]
49+
[SupportsWildcards()]
4950
public string Name { get; set; }
5051

5152
[Parameter(HelpMessage = "Queue Prefix",

‎src/Storage/Commands.Storage/Table/Cmdlet/GetStorageAzureTable.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ public class GetAzureStorageTableCommand : StorageCloudTableCmdletBase
4545
ValueFromPipeline = true,
4646
ValueFromPipelineByPropertyName = true,
4747
ParameterSetName = NameParameterSet)]
48+
[SupportsWildcards()]
4849
public string Name { get; set; }
4950

5051
[Parameter(HelpMessage = "Table Prefix",

‎src/Storage/Commands.Storage/help/Get-AzureStorageBlob.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,15 @@ Lists blobs in a container.
1515
### BlobName (Default)
1616
```
1717
Get-AzureStorageBlob [[-Blob] <String>] [-Container] <String> [-MaxCount <Int32>]
18-
[-ContinuationToken <BlobContinuationToken>] [-Context <AzureStorageContext>]
19-
[-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>]
20-
[<CommonParameters>]
18+
[-ContinuationToken <BlobContinuationToken>] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>]
19+
[-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>]
2120
```
2221

2322
### BlobPrefix
2423
```
2524
Get-AzureStorageBlob [-Prefix <String>] [-Container] <String> [-MaxCount <Int32>]
26-
[-ContinuationToken <BlobContinuationToken>] [-Context <AzureStorageContext>]
27-
[-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>]
28-
[<CommonParameters>]
25+
[-ContinuationToken <BlobContinuationToken>] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>]
26+
[-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>]
2927
```
3028

3129
## DESCRIPTION
@@ -97,7 +95,7 @@ Required: False
9795
Position: 0
9896
Default value: None
9997
Accept pipeline input: False
100-
Accept wildcard characters: False
98+
Accept wildcard characters: True
10199
```
102100
103101
### -ClientTimeoutPerRequest
@@ -156,7 +154,7 @@ Specifies the Azure storage account from which you want to get a list of blobs.
156154
You can use the New-AzureStorageContext cmdlet to create a storage context.
157155
158156
```yaml
159-
Type: AzureStorageContext
157+
Type: IStorageContext
160158
Parameter Sets: (All)
161159
Aliases:
162160

‎src/Storage/Commands.Storage/help/Get-AzureStorageBlobContent.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,21 @@ Downloads a storage blob.
1515
### ReceiveManual (Default)
1616
```
1717
Get-AzureStorageBlobContent [-Blob] <String> [-Container] <String> [-Destination <String>] [-CheckMd5] [-Force]
18-
[-Context <AzureStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
18+
[-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
1919
[-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]
2020
```
2121

2222
### BlobPipeline
2323
```
2424
Get-AzureStorageBlobContent -CloudBlob <CloudBlob> [-Destination <String>] [-CheckMd5] [-Force]
25-
[-Context <AzureStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
25+
[-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
2626
[-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]
2727
```
2828

2929
### ContainerPipeline
3030
```
3131
Get-AzureStorageBlobContent -CloudBlobContainer <CloudBlobContainer> [-Blob] <String> [-Destination <String>]
32-
[-CheckMd5] [-Force] [-Context <AzureStorageContext>] [-ServerTimeoutPerRequest <Int32>]
32+
[-CheckMd5] [-Force] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>]
3333
[-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]
3434
```
3535

@@ -182,7 +182,7 @@ Specifies the Azure storage account from which you want to download blob content
182182
You can use the New-AzureStorageContext cmdlet to create a storage context.
183183
184184
```yaml
185-
Type: AzureStorageContext
185+
Type: IStorageContext
186186
Parameter Sets: (All)
187187
Aliases:
188188

‎src/Storage/Commands.Storage/help/Get-AzureStorageBlobCopyState.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,21 @@ Gets the copy status of an Azure Storage blob.
1515
### NamePipeline (Default)
1616
```
1717
Get-AzureStorageBlobCopyState [-Blob] <String> [-Container] <String> [-WaitForComplete]
18-
[-Context <AzureStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
18+
[-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
1919
[-ConcurrentTaskCount <Int32>] [<CommonParameters>]
2020
```
2121

2222
### BlobPipeline
2323
```
24-
Get-AzureStorageBlobCopyState -CloudBlob <CloudBlob> [-WaitForComplete] [-Context <AzureStorageContext>]
24+
Get-AzureStorageBlobCopyState -CloudBlob <CloudBlob> [-WaitForComplete] [-Context <IStorageContext>]
2525
[-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>]
2626
[<CommonParameters>]
2727
```
2828

2929
### ContainerPipeline
3030
```
3131
Get-AzureStorageBlobCopyState -CloudBlobContainer <CloudBlobContainer> [-Blob] <String> [-WaitForComplete]
32-
[-Context <AzureStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
32+
[-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
3333
[-ConcurrentTaskCount <Int32>] [<CommonParameters>]
3434
```
3535

@@ -169,7 +169,7 @@ Specifies an Azure storage context.
169169
To obtain a storage context, use the New-AzureStorageContext cmdlet.
170170
171171
```yaml
172-
Type: AzureStorageContext
172+
Type: IStorageContext
173173
Parameter Sets: (All)
174174
Aliases:
175175

‎src/Storage/Commands.Storage/help/Get-AzureStorageCORSRule.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Gets CORS rules for a Storage service type.
1313
## SYNTAX
1414

1515
```
16-
Get-AzureStorageCORSRule [-ServiceType] <StorageServiceType> [-Context <AzureStorageContext>]
16+
Get-AzureStorageCORSRule [-ServiceType] <StorageServiceType> [-Context <IStorageContext>]
1717
[-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>]
1818
[<CommonParameters>]
1919
```
@@ -73,7 +73,7 @@ Specifies an Azure Storage context.
7373
To obtain a context, use the New-AzureStorageContext cmdlet.
7474
7575
```yaml
76-
Type: AzureStorageContext
76+
Type: IStorageContext
7777
Parameter Sets: (All)
7878
Aliases:
7979

‎src/Storage/Commands.Storage/help/Get-AzureStorageContainer.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ Lists the storage containers.
1515
### ContainerName (Default)
1616
```
1717
Get-AzureStorageContainer [[-Name] <String>] [-MaxCount <Int32>] [-ContinuationToken <BlobContinuationToken>]
18-
[-Context <AzureStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
18+
[-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
1919
[-ConcurrentTaskCount <Int32>] [<CommonParameters>]
2020
```
2121

2222
### ContainerPrefix
2323
```
2424
Get-AzureStorageContainer -Prefix <String> [-MaxCount <Int32>] [-ContinuationToken <BlobContinuationToken>]
25-
[-Context <AzureStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
25+
[-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
2626
[-ConcurrentTaskCount <Int32>] [<CommonParameters>]
2727
```
2828

@@ -88,7 +88,7 @@ Specifies the storage context.
8888
To create it, you can use the New-AzureStorageContext cmdlet.
8989
9090
```yaml
91-
Type: AzureStorageContext
91+
Type: IStorageContext
9292
Parameter Sets: (All)
9393
Aliases:
9494

@@ -143,7 +143,7 @@ Required: False
143143
Position: 0
144144
Default value: None
145145
Accept pipeline input: True (ByPropertyName, ByValue)
146-
Accept wildcard characters: False
146+
Accept wildcard characters: True
147147
```
148148
149149
### -Prefix

‎src/Storage/Commands.Storage/help/Get-AzureStorageContainerStoredAccessPolicy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Gets the stored access policy or policies for an Azure storage container.
1414

1515
```
1616
Get-AzureStorageContainerStoredAccessPolicy [-Container] <String> [[-Policy] <String>]
17-
[-Context <AzureStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
17+
[-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
1818
[-ConcurrentTaskCount <Int32>] [<CommonParameters>]
1919
```
2020

@@ -94,7 +94,7 @@ Accept wildcard characters: False
9494
Specifies the Azure storage context.
9595
9696
```yaml
97-
Type: AzureStorageContext
97+
Type: IStorageContext
9898
Parameter Sets: (All)
9999
Aliases:
100100

‎src/Storage/Commands.Storage/help/Get-AzureStorageFile.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Lists directories and files for a path.
1414

1515
### ShareName (Default)
1616
```
17-
Get-AzureStorageFile [-ShareName] <String> [[-Path] <String>] [-Context <AzureStorageContext>]
17+
Get-AzureStorageFile [-ShareName] <String> [[-Path] <String>] [-Context <IStorageContext>]
1818
[-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>]
1919
[<CommonParameters>]
2020
```
@@ -99,7 +99,7 @@ Specifies an Azure Storage context.
9999
To obtain a Storage context, use the New-AzureStorageContext cmdlet.
100100
101101
```yaml
102-
Type: AzureStorageContext
102+
Type: IStorageContext
103103
Parameter Sets: ShareName
104104
Aliases:
105105

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Downloads the contents of a file.
1515
### ShareName (Default)
1616
```
1717
Get-AzureStorageFileContent [-ShareName] <String> [-Path] <String> [[-Destination] <String>] [-CheckMd5]
18-
[-PassThru] [-Force] [-Context <AzureStorageContext>] [-ServerTimeoutPerRequest <Int32>]
18+
[-PassThru] [-Force] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>]
1919
[-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]
2020
```
2121

@@ -127,7 +127,7 @@ If you specify a path of an existing file and you do not specify *Force*, the cm
127127
If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file.
128128
129129
```yaml
130-
Type: AzureStorageContext
130+
Type: IStorageContext
131131
Parameter Sets: ShareName
132132
Aliases:
133133

‎src/Storage/Commands.Storage/help/Get-AzureStorageFileCopyState.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Gets the state of a copy operation.
1515
### ShareName
1616
```
1717
Get-AzureStorageFileCopyState [-ShareName] <String> [-FilePath] <String> [-WaitForComplete]
18-
[-Context <AzureStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
18+
[-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
1919
[-ConcurrentTaskCount <Int32>] [<CommonParameters>]
2020
```
2121

@@ -80,7 +80,7 @@ Specifies an Azure Storage context.
8080
To obtain a context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet.
8181
8282
```yaml
83-
Type: AzureStorageContext
83+
Type: IStorageContext
8484
Parameter Sets: ShareName
8585
Aliases:
8686

‎src/Storage/Commands.Storage/help/Get-AzureStorageQueue.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ Lists storage queues.
1414

1515
### QueueName (Default)
1616
```
17-
Get-AzureStorageQueue [[-Name] <String>] [-Context <AzureStorageContext>] [<CommonParameters>]
17+
Get-AzureStorageQueue [[-Name] <String>] [-Context <IStorageContext>] [<CommonParameters>]
1818
```
1919

2020
### QueuePrefix
2121
```
22-
Get-AzureStorageQueue -Prefix <String> [-Context <AzureStorageContext>] [<CommonParameters>]
22+
Get-AzureStorageQueue -Prefix <String> [-Context <IStorageContext>] [<CommonParameters>]
2323
```
2424

2525
## DESCRIPTION
@@ -55,7 +55,7 @@ Specifies the Azure storage context.
5555
You can create it by using the **New-AzureStorageContext** cmdlet.
5656

5757
```yaml
58-
Type: AzureStorageContext
58+
Type: IStorageContext
5959
Parameter Sets: (All)
6060
Aliases:
6161

@@ -80,7 +80,7 @@ Required: False
8080
Position: 0
8181
Default value: None
8282
Accept pipeline input: True (ByPropertyName, ByValue)
83-
Accept wildcard characters: False
83+
Accept wildcard characters: True
8484
```
8585
8686
### -Prefix

‎src/Storage/Commands.Storage/help/Get-AzureStorageQueueStoredAccessPolicy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Gets the stored access policy or policies for an Azure storage queue.
1313
## SYNTAX
1414

1515
```
16-
Get-AzureStorageQueueStoredAccessPolicy [-Queue] <String> [[-Policy] <String>] [-Context <AzureStorageContext>]
16+
Get-AzureStorageQueueStoredAccessPolicy [-Queue] <String> [[-Policy] <String>] [-Context <IStorageContext>]
1717
[<CommonParameters>]
1818
```
1919

@@ -43,7 +43,7 @@ Specifies the Azure storage context.
4343
To obtain a storage context, use the New-AzureStorageContext cmdlet.
4444

4545
```yaml
46-
Type: AzureStorageContext
46+
Type: IStorageContext
4747
Parameter Sets: (All)
4848
Aliases:
4949

‎src/Storage/Commands.Storage/help/Get-AzureStorageServiceLoggingProperty.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Gets logging properties for Azure Storage services.
1313
## SYNTAX
1414

1515
```
16-
Get-AzureStorageServiceLoggingProperty [-ServiceType] <StorageServiceType> [-Context <AzureStorageContext>]
16+
Get-AzureStorageServiceLoggingProperty [-ServiceType] <StorageServiceType> [-Context <IStorageContext>]
1717
[<CommonParameters>]
1818
```
1919

@@ -36,7 +36,7 @@ Specifies an Azure storage context.
3636
To obtain a storage context, use the New-AzureStorageContext cmdlet.
3737

3838
```yaml
39-
Type: AzureStorageContext
39+
Type: IStorageContext
4040
Parameter Sets: (All)
4141
Aliases:
4242

‎src/Storage/Commands.Storage/help/Get-AzureStorageServiceMetricsProperty.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Gets metrics properties for the Azure Storage service.
1414

1515
```
1616
Get-AzureStorageServiceMetricsProperty [-ServiceType] <StorageServiceType> [-MetricsType] <ServiceMetricsType>
17-
[-Context <AzureStorageContext>] [<CommonParameters>]
17+
[-Context <IStorageContext>] [<CommonParameters>]
1818
```
1919

2020
## DESCRIPTION
@@ -36,7 +36,7 @@ Specifies an Azure storage context.
3636
To obtain a storage context, use the New-AzureStorageContext cmdlet.
3737

3838
```yaml
39-
Type: AzureStorageContext
39+
Type: IStorageContext
4040
Parameter Sets: (All)
4141
Aliases:
4242

‎src/Storage/Commands.Storage/help/Get-AzureStorageShare.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ Gets a list of file shares.
1414

1515
### MatchingPrefix (Default)
1616
```
17-
Get-AzureStorageShare [[-Prefix] <String>] [-Context <AzureStorageContext>] [-ServerTimeoutPerRequest <Int32>]
17+
Get-AzureStorageShare [[-Prefix] <String>] [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>]
1818
[-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>]
1919
```
2020

2121
### Specific
2222
```
23-
Get-AzureStorageShare [-Name] <String> [-Context <AzureStorageContext>] [-ServerTimeoutPerRequest <Int32>]
23+
Get-AzureStorageShare [-Name] <String> [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>]
2424
[-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>]
2525
```
2626

@@ -96,7 +96,7 @@ Specifies an Azure Storage context.
9696
To obtain a context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet.
9797
9898
```yaml
99-
Type: AzureStorageContext
99+
Type: IStorageContext
100100
Parameter Sets: (All)
101101
Aliases:
102102

‎src/Storage/Commands.Storage/help/Get-AzureStorageShareStoredAccessPolicy.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Gets stored access policies for a Storage share.
1313
## SYNTAX
1414

1515
```
16-
Get-AzureStorageShareStoredAccessPolicy [-ShareName] <String> [[-Policy] <String>]
17-
[-Context <AzureStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
18-
[-ConcurrentTaskCount <Int32>] [<CommonParameters>]
16+
Get-AzureStorageShareStoredAccessPolicy [-ShareName] <String> [[-Policy] <String>] [-Context <IStorageContext>]
17+
[-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>] [-ConcurrentTaskCount <Int32>]
18+
[<CommonParameters>]
1919
```
2020

2121
## DESCRIPTION
@@ -81,7 +81,7 @@ Specifies an Azure Storage context.
8181
To obtain a context, use the [New-AzureStorageContext](./New-AzureStorageContext.md) cmdlet.
8282
8383
```yaml
84-
Type: AzureStorageContext
84+
Type: IStorageContext
8585
Parameter Sets: (All)
8686
Aliases:
8787

0 commit comments

Comments
 (0)