Skip to content

Commit c9756c6

Browse files
ttorblettorble
authored
Merge pull request #206493 from jimmart-dev/jammart-blobfuse2-completion-secure-commands
create completion and secure cmd refs
2 parents c04a8e5 + 30c8b30 commit c9756c6

11 files changed

+761
-0
lines changed

‎articles/storage/blobs/TOC.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -702,6 +702,30 @@ items:
702702
href: ../common/storage-ref-azcopy-sync.md?toc=%2fazure%2fstorage%2fblobs%2ftoc.json
703703
- name: azcopy set-properties
704704
href: ../common/storage-ref-azcopy-set-properties.md?toc=%2fazure%2fstorage%2fblobs%2ftoc.json
705+
- name: BlobFuse2
706+
items:
707+
- name: BlobFuse2 completion
708+
href: blobfuse2-commands-completion.md?toc=%2fazure%2fstorage%2fblobs%2ftoc.json
709+
items:
710+
- name: BlobFuse2 completion bash
711+
href: blobfuse2-commands-completion-bash.md?toc=%2fazure%2fstorage%2fblobs%2ftoc.json
712+
- name: BlobFuse2 completion fish
713+
href: blobfuse2-commands-completion-fish.md?toc=%2fazure%2fstorage%2fblobs%2ftoc.json
714+
- name: BlobFuse2 completion PowerShell
715+
href: blobfuse2-commands-completion-powershell.md?toc=%2fazure%2fstorage%2fblobs%2ftoc.json
716+
- name: BlobFuse2 completion zsh
717+
href: blobfuse2-commands-completion-zsh.md?toc=%2fazure%2fstorage%2fblobs%2ftoc.json
718+
- name: BlobFuse2 secure
719+
href: blobfuse2-commands-secure.md?toc=%2fazure%2fstorage%2fblobs%2ftoc.json
720+
items:
721+
- name: BlobFuse2 secure encrypt
722+
href: blobfuse2-commands-secure-encrypt.md?toc=%2fazure%2fstorage%2fblobs%2ftoc.json
723+
- name: BlobFuse2 secure decrypt
724+
href: blobfuse2-commands-secure-decrypt.md?toc=%2fazure%2fstorage%2fblobs%2ftoc.json
725+
- name: BlobFuse2 secure get
726+
href: blobfuse2-commands-secure-get.md?toc=%2fazure%2fstorage%2fblobs%2ftoc.json
727+
- name: BlobFuse2 secure set
728+
href: blobfuse2-commands-secure-set.md?toc=%2fazure%2fstorage%2fblobs%2ftoc.json
705729
- name: Resource Manager template
706730
displayName: ARM
707731
href: /azure/templates/microsoft.storage/allversions

‎articles/storage/blobs/blobfuse2-commands-completion-bash.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
title: How to use the completion bash command to generate the autocompletion script for BlobFuse2 | Microsoft Docs
3+
description: Learn how to use the completion bash command to generate the autocompletion script for BlobFuse2.
4+
author: jimmart-dev
5+
ms.service: storage
6+
ms.subservice: blobs
7+
ms.topic: how-to
8+
ms.date: 07/27/2022
9+
ms.author: jammart
10+
ms.reviewer: tamram
11+
---
12+
13+
# BlobFuse2 completion bash command
14+
15+
Use the `blobfuse2 completion bash` command to generate the autocompletion script for BlobFuse2 for the bash shell.
16+
17+
> [!IMPORTANT]
18+
> BlobFuse2 is the next generation of BlobFuse and is currently in preview.
19+
> This preview version is provided without a service level agreement, and is not recommended for production workloads. Certain features might not be supported or might have constrained capabilities.
20+
> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
21+
>
22+
> BlobFuse v1 is generally available (GA). For information about the GA version, see:
23+
>
24+
> - [The BlobFuse v1 project on GitHub](https://github.com/Azure/azure-storage-fuse/tree/master)
25+
> - [The BlobFuse v1 setup documentation](storage-how-to-mount-container-linux.md)
26+
27+
## Syntax
28+
29+
`blobfuse2 completion bash --[flag-name]=[flag-value]`
30+
31+
## Flags (options)
32+
33+
Flags that apply to `blobfuse2 completion bash` are inherited from the grandparent command, `blobfuse2`, or apply only to the [`blobfuse2 completion`](blobfuse2-commands-completion.md) subcommands.
34+
35+
### Flags inherited from the BlobFuse2 command
36+
37+
The following flags are inherited from grandparent command `blobfuse2`:
38+
39+
| Flag | Short version | Value type | Default value | Description |
40+
|--|--|--|--|--|
41+
| disable-version-check | | boolean | false | Enables or disables automatic version checking of the BlobFuse2 binaries |
42+
| help | -h | n/a | | Help info for the blobfuse2 command and subcommands |
43+
44+
### Flags that apply to the BlobFuse2 completion subcommands
45+
46+
The following flags apply only to the `blobfuse2 completion` subcommands:
47+
48+
| Flag | Value type | Default value | Description |
49+
|--|--|--|--|
50+
| no-descriptions | boolean | false | Disable completion descriptions |
51+
52+
## Usage
53+
54+
The generated script depends on the 'bash-completion' package. If it is not installed already, you can install it via your OS's package manager.
55+
56+
To load completions in your current shell session:
57+
58+
```bash
59+
source <(blobfuse2 completion bash)
60+
```
61+
62+
To load completions for every new session, execute once:
63+
64+
- On Linux:
65+
66+
```bash
67+
blobfuse2 completion bash > /etc/bash_completion.d/blobfuse2
68+
```
69+
70+
- On macOS:
71+
72+
```bash
73+
blobfuse2 completion bash > /usr/local/etc/bash_completion.d/blobfuse2
74+
````
75+
76+
> [!NOTE]
77+
> You will need to start a new shell for this setup to take effect.
78+
79+
## See also
80+
81+
- [The Blobfuse2 completion command](blobfuse2-commands-completion.md)
82+
- [The Blobfuse2 completion fish command](blobfuse2-commands-completion-fish.md)
83+
- [The Blobfuse2 completion PowerShell command](blobfuse2-commands-completion-powershell.md)
84+
- [The Blobfuse2 completion zsh command](blobfuse2-commands-completion-zsh.md)

‎articles/storage/blobs/blobfuse2-commands-completion-fish.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: How to use the completion fish command to generate the autocompletion script for BlobFuse2 | Microsoft Docs
3+
description: Learn how to use the completion fish command to generate the autocompletion script for BlobFuse2.
4+
author: jimmart-dev
5+
ms.service: storage
6+
ms.subservice: blobs
7+
ms.topic: how-to
8+
ms.date: 07/27/2022
9+
ms.author: jammart
10+
ms.reviewer: tamram
11+
---
12+
13+
# BlobFuse2 completion fish command
14+
15+
Use the `blobfuse2 completion fish` command to generate the autocompletion script for BlobFuse2 for the fish shell.
16+
17+
> [!IMPORTANT]
18+
> BlobFuse2 is the next generation of BlobFuse and is currently in preview.
19+
> This preview version is provided without a service level agreement, and is not recommended for production workloads. Certain features might not be supported or might have constrained capabilities.
20+
> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
21+
>
22+
> BlobFuse v1 is generally available (GA). For information about the GA version, see:
23+
>
24+
> - [The BlobFuse v1 project on GitHub](https://github.com/Azure/azure-storage-fuse/tree/master)
25+
> - [The BlobFuse v1 setup documentation](storage-how-to-mount-container-linux.md)
26+
27+
## Syntax
28+
29+
`blobfuse2 completion fish --[flag-name]=[flag-value]`
30+
31+
## Flags (options)
32+
33+
Flags that apply to `blobfuse2 completion fish` are inherited from the grandparent command, `blobfuse2`, or apply only to the [`blobfuse2 completion`](blobfuse2-commands-completion.md) subcommands.
34+
35+
### Flags inherited from the BlobFuse2 command
36+
37+
The following flags are inherited from grandparent command `blobfuse2`:
38+
39+
| Flag | Short version | Value type | Default value | Description |
40+
|--|--|--|--|--|
41+
| disable-version-check | | boolean | false | Enables or disables automatic version checking of the BlobFuse2 binaries |
42+
| help | -h | n/a | | Help info for the blobfuse2 command and subcommands |
43+
44+
### Flags that apply to the BlobFuse2 completion subcommands
45+
46+
The following flags apply only to the `blobfuse2 completion` subcommands:
47+
48+
| Flag | Value type | Default value | Description |
49+
|--|--|--|--|
50+
| no-descriptions | boolean | false | Disable completion descriptions |
51+
52+
## Usage
53+
54+
To load completions in your current shell session:
55+
56+
`blobfuse2 completion fish | source`
57+
58+
To load completions for every new session, execute once:
59+
60+
`blobfuse2 completion fish > ~/.config/fish/completions/blobfuse2.fish`
61+
62+
> [!NOTE]
63+
> You will need to start a new shell for this setup to take effect.
64+
65+
## See also
66+
67+
- [The Blobfuse2 completion command](blobfuse2-commands-completion.md)
68+
- [The Blobfuse2 completion bash command](blobfuse2-commands-completion-bash.md)
69+
- [The Blobfuse2 completion PowerShell command](blobfuse2-commands-completion-powershell.md)
70+
- [The Blobfuse2 completion zsh command](blobfuse2-commands-completion-zsh.md)

‎articles/storage/blobs/blobfuse2-commands-completion-powershell.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: How to use the "completion powershell" command to generate the autocompletion script for BlobFuse2 | Microsoft Docs
3+
description: Learn how to use the "completion powershell" command to generate the autocompletion script for BlobFuse2.
4+
author: jimmart-dev
5+
ms.service: storage
6+
ms.subservice: blobs
7+
ms.topic: how-to
8+
ms.date: 07/27/2022
9+
ms.author: jammart
10+
ms.reviewer: tamram
11+
---
12+
13+
# BlobFuse2 completion powershell command
14+
15+
Use the `blobfuse2 completion powershell` command to generate the autocompletion script for BlobFuse2 for PowerShell.
16+
17+
> [!IMPORTANT]
18+
> BlobFuse2 is the next generation of BlobFuse and is currently in preview.
19+
> This preview version is provided without a service level agreement, and is not recommended for production workloads. Certain features might not be supported or might have constrained capabilities.
20+
> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
21+
>
22+
> BlobFuse v1 is generally available (GA). For information about the GA version, see:
23+
>
24+
> - [The BlobFuse v1 project on GitHub](https://github.com/Azure/azure-storage-fuse/tree/master)
25+
> - [The BlobFuse v1 setup documentation](storage-how-to-mount-container-linux.md)
26+
27+
## Syntax
28+
29+
`blobfuse2 completion powershell --[flag-name]=[flag-value]`
30+
31+
## Flags (options)
32+
33+
Flags that apply to `blobfuse2 completion powershell` are inherited from the grandparent command, `blobfuse2`, or apply only to the [`blobfuse2 completion`](blobfuse2-commands-completion.md) subcommands.
34+
35+
### Flags inherited from the BlobFuse2 command
36+
37+
The following flags are inherited from grandparent command `blobfuse2`:
38+
39+
| Flag | Short version | Value type | Default value | Description |
40+
|--|--|--|--|--|
41+
| disable-version-check | | boolean | false | Enables or disables automatic version checking of the BlobFuse2 binaries |
42+
| help | -h | n/a | | Help info for the blobfuse2 command and subcommands |
43+
44+
### Flags that apply to the BlobFuse2 completion subcommands
45+
46+
The following flags apply only to the `blobfuse2 completion` subcommands:
47+
48+
| Flag | Value type | Default value | Description |
49+
|--|--|--|--|
50+
| no-descriptions | boolean | false | Disable completion descriptions |
51+
52+
## Usage
53+
54+
To load completions in your current PowerShell session:
55+
56+
```powershell
57+
blobfuse2 completion powershell | Out-String | Invoke-Expression
58+
```
59+
60+
To load completions for every new session, add the output of the above command
61+
to your PowerShell profile.
62+
63+
> [!NOTE]
64+
> You will need to start a new shell for this setup to take effect.
65+
66+
## See also
67+
68+
- [The Blobfuse2 completion command](blobfuse2-commands-completion.md)
69+
- [The Blobfuse2 completion bash command](blobfuse2-commands-completion-bash.md)
70+
- [The Blobfuse2 completion fish command](blobfuse2-commands-completion-fish.md)
71+
- [The Blobfuse2 completion zsh command](blobfuse2-commands-completion-zsh.md)

‎articles/storage/blobs/blobfuse2-commands-completion-zsh.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
title: How to use the completion zsh command to generate the autocompletion script for BlobFuse2 | Microsoft Docs
3+
description: Learn how to use the completion zsh command to generate the autocompletion script for BlobFuse2.
4+
author: jimmart-dev
5+
ms.service: storage
6+
ms.subservice: blobs
7+
ms.topic: how-to
8+
ms.date: 07/27/2022
9+
ms.author: jammart
10+
ms.reviewer: tamram
11+
---
12+
13+
# BlobFuse2 completion zsh command
14+
15+
Use the `blobfuse2 completion zsh` command to generate the autocompletion script for BlobFuse2 for the zsh shell.
16+
17+
> [!IMPORTANT]
18+
> BlobFuse2 is the next generation of BlobFuse and is currently in preview.
19+
> This preview version is provided without a service level agreement, and is not recommended for production workloads. Certain features might not be supported or might have constrained capabilities.
20+
> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
21+
>
22+
> BlobFuse v1 is generally available (GA). For information about the GA version, see:
23+
>
24+
> - [The BlobFuse v1 project on GitHub](https://github.com/Azure/azure-storage-fuse/tree/master)
25+
> - [The BlobFuse v1 setup documentation](storage-how-to-mount-container-linux.md)
26+
27+
## Syntax
28+
29+
`blobfuse2 completion zsh --[flag-name]=[flag-value]`
30+
31+
## Flags (options)
32+
33+
Flags that apply to `blobfuse2 completion zsh` are inherited from the grandparent command, `blobfuse2`, or apply only to the [`blobfuse2 completion`](blobfuse2-commands-completion.md) subcommands.
34+
35+
### Flags inherited from the BlobFuse2 command
36+
37+
The following flags are inherited from grandparent command `blobfuse2`:
38+
39+
| Flag | Short version | Value type | Default value | Description |
40+
|--|--|--|--|--|
41+
| disable-version-check | | boolean | false | Enables or disables automatic version checking of the BlobFuse2 binaries |
42+
| help | -h | n/a | | Help info for the blobfuse2 command and subcommands |
43+
44+
### Flags that apply to the BlobFuse2 completion subcommands
45+
46+
The following flags apply only to the `blobfuse2 completion` subcommands:
47+
48+
| Flag | Value type | Default value | Description |
49+
|--|--|--|--|
50+
| no-descriptions | boolean | false | Disable completion descriptions |
51+
52+
## Usage
53+
54+
If shell completion is not already enabled in your environment you will need
55+
to enable it. To do so, run the following command once:
56+
57+
`echo "autoload -U compinit; compinit" >> ~/.zshrc`
58+
59+
To load completions in your current shell session:
60+
61+
`source <(blobfuse2 completion zsh); compdef _blobfuse2 blobfuse2`
62+
63+
To load completions for every new session, execute once:
64+
65+
- On Linux:
66+
67+
`blobfuse2 completion zsh > "${fpath[1]}/_blobfuse2"`
68+
69+
- On macOS:
70+
71+
`blobfuse2 completion zsh > /usr/local/share/zsh/site-functions/_blobfuse2`
72+
73+
> [!NOTE]
74+
> You will need to start a new shell for this setup to take effect.
75+
76+
## See also
77+
78+
- [The Blobfuse2 completion command](blobfuse2-commands-completion.md)
79+
- [The Blobfuse2 completion bash command](blobfuse2-commands-completion-bash.md)
80+
- [The Blobfuse2 completion fish command](blobfuse2-commands-completion-fish.md)
81+
- [The Blobfuse2 completion PowerShell command](blobfuse2-commands-completion-powershell.md)

0 commit comments

Comments
 (0)