Skip to content

Get-AzStorageFileContent documentation for Context parameter is wrong #8751

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.

Sign up for GitHub

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 2 commits into from
Mar 12, 2019
Merged

Get-AzStorageFileContent documentation for Context parameter is wrong #8751

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1fa95a2
Update Get-AzStorageFileContent.md
mikedouglasdev Mar 3, 2019
ba491d0
[Storage] Continue update Get-AzStorageFileContent.md
blueww Mar 5, 2019
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
30 changes: 6 additions & 24 deletions src/Storage/Storage.Management/help/Get-AzStorageFileContent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,7 @@ This example downloads the files under sample file share
## PARAMETERS

### -CheckMd5
If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file.
If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file.
If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues.
If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file.
Specifies whether to check the Md5 sum for the downloaded file.

```yaml
Type: System.Management.Automation.SwitchParameter
Expand All @@ -86,10 +83,7 @@ Accept wildcard characters: False
```

### -ClientTimeoutPerRequest
If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file.
If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file.
If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues.
If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file.
Specifies the client-side time-out interval, in seconds, for one service request. If the previous call fails in the specified interval, this cmdlet retries the request. If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error.

```yaml
Type: System.Nullable`1[System.Int32]
Expand All @@ -104,10 +98,7 @@ Accept wildcard characters: False
```

### -ConcurrentTaskCount
If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file.
If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file.
If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues.
If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file.
Specifies the maximum concurrent network calls. You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. The specified value is an absolute count and is not multiplied by the core count. This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. The default value is 10.

```yaml
Type: System.Nullable`1[System.Int32]
Expand All @@ -122,10 +113,7 @@ Accept wildcard characters: False
```

### -Context
If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file.
If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file.
If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues.
If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file.
Specifies an Azure Storage context. To obtain a context, use the New-AzStorageContext cmdlet.

```yaml
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext
Expand Down Expand Up @@ -228,10 +216,7 @@ Accept wildcard characters: False
```

### -PassThru
If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file.
If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file.
If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues.
If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file.
Indicates that this cmdlet returns the **AzureStorageFile** object that it downloads.

```yaml
Type: System.Management.Automation.SwitchParameter
Expand Down Expand Up @@ -263,10 +248,7 @@ Accept wildcard characters: False
```

### -ServerTimeoutPerRequest
If you specify the path of a file that does not exist, this cmdlet creates that file, and saves the contents in the new file.
If you specify a path of a file that already exists and you specify the *Force* parameter, the cmdlet overwrites the file.
If you specify a path of an existing file and you do not specify *Force*, the cmdlet prompts you before it continues.
If you specify the path of a folder, this cmdlet attempts to create a file that has the name of the Azure storage file.
Specifies the service side time-out interval, in seconds, for a request. If the specified interval elapses before the service processes the request, the storage service returns an error.

```yaml
Type: System.Nullable`1[System.Int32]
Expand Down