|
1 | | -========================================== |
2 | | -# Azure CLI Storage Sync Extension # |
3 | | -This is a extension for StorageSync features. |
4 | | - |
5 | | -### How to use ### |
6 | | -Install this extension using the below CLI command |
7 | | -``` |
8 | | -az extension add --name storagesync |
9 | | -``` |
10 | | - |
11 | | -### Included Features |
12 | | -#### Manage storage sync service: |
13 | | - |
14 | | -##### Create a new storage sync service. |
15 | | - |
16 | | -``` |
17 | | -az storagesync create \ |
18 | | - --resource-group rg \ |
19 | | - --name storage_sync_service_name \ |
20 | | - --location westus \ |
21 | | - --tags key1=value1 |
22 | | -``` |
23 | | - |
24 | | -##### Delete a given storage sync service. |
25 | | -``` |
26 | | -az storagesync delete \ |
27 | | - --resource-group rg \ |
28 | | - --name storage_sync_service_name |
29 | | -``` |
30 | | - |
31 | | -##### Show the properties for a given storage sync service. |
32 | | -``` |
33 | | -az storagesync show \ |
34 | | - --resource-group rg \ |
35 | | - --name storage_sync_service_name |
36 | | -``` |
37 | | - |
38 | | -##### List all storage sync services in a resource group or a subscription. |
39 | | -``` |
40 | | -az storagesync list |
41 | | -``` |
42 | | -``` |
43 | | -az storagesync list \ |
44 | | - --resource-group rg |
45 | | -``` |
46 | | - |
47 | | -#### Manage sync group: |
48 | | - |
49 | | -##### Create a new sync group. |
50 | | -``` |
51 | | -az storagesync sync-group create \ |
52 | | - --resource-group rg \ |
53 | | - --name sync_group_name \ |
54 | | - --storage-sync-service storage-sync-service-name |
55 | | -``` |
56 | | - |
57 | | -##### Delete a given sync group. |
58 | | -``` |
59 | | -az storagesync sync-group delete \ |
60 | | - --resource-group rg \ |
61 | | - --name sync_group_name \ |
62 | | - --storage-sync-service storage-sync-service-name |
63 | | -``` |
64 | | - |
65 | | -##### Show the properties for a given sync group. |
66 | | -``` |
67 | | -az storagesync sync-group show \ |
68 | | - --resource-group rg \ |
69 | | - --name sync_group_name \ |
70 | | - --storage-sync-service storage-sync-service-name |
71 | | -``` |
72 | | - |
73 | | -##### List all sync groups in a storage sync service. |
74 | | -``` |
75 | | -az storagesync sync-group list \ |
76 | | - --resource-group rg \ |
77 | | - --storage-sync-service storage-sync-service-name |
78 | | -``` |
79 | | - |
80 | | -#### Manage cloud endpoint. |
81 | | - |
82 | | -##### Create a new cloud endpoint. |
83 | | -``` |
84 | | -az storagesync sync-group cloud-endpoint create \ |
85 | | - --resource-group rg \ |
86 | | - --name cloud-endpoint-name \ |
87 | | - --storage-sync-service storage-sync-service-name \ |
88 | | - --sync-group-name sync-group-name \ |
89 | | - --storage-account storageaccountnameorid \ |
90 | | - --azure-file-share-name file-share-name |
91 | | -``` |
92 | | - |
93 | | -##### Delete a given cloud endpoint. |
94 | | -``` |
95 | | -az storagesync sync-group cloud-endpoint delete \ |
96 | | - --resource-group rg \ |
97 | | - --name cloud-endpoint-name \ |
98 | | - --storage-sync-service storage-sync-service-name \ |
99 | | - --sync-group-name sync-group-name |
100 | | -``` |
101 | | - |
102 | | -##### Show the properties for a given cloud endpoint. |
103 | | -``` |
104 | | -az storagesync sync-group cloud-endpoint show \ |
105 | | - --resource-group rg \ |
106 | | - --name cloud-endpoint-name \ |
107 | | - --storage-sync-service storage-sync-service-name \ |
108 | | - --sync-group-name sync-group-name |
109 | | -``` |
110 | | - |
111 | | -##### List all cloud endpoints in a sync group. |
112 | | -``` |
113 | | -az storagesync sync-group cloud-endpoint list \ |
114 | | - --resource-group rg \ |
115 | | - --storage-sync-service storage-sync-service-name \ |
116 | | - --sync-group-name sync-group-name |
117 | | -``` |
118 | | - |
119 | | -#### Manage cloud endpoint. |
120 | | - |
121 | | -##### Create a new server endpoint. |
122 | | -``` |
123 | | -az storagesync sync-group server-endpoint create \ |
124 | | - --resource-group rg \ |
125 | | - --name server-endpoint-name \ |
126 | | - --storage-sync-service storage-sync-service-name \ |
127 | | - --sync-group-name sync-group-name \ |
128 | | - --server-id server-id \ |
129 | | - --server-local-path "d:\\abc" |
130 | | -``` |
131 | | - |
132 | | -##### Update the properties for a given server endpoint. |
133 | | -``` |
134 | | -az storagesync sync-group server-endpoint create \ |
135 | | - --resource-group rg \ |
136 | | - --name server-endpoint-name \ |
137 | | - --storage-sync-service storage-sync-service-name \ |
138 | | - --sync-group-name sync-group-name \ |
139 | | - --server-id server-id \ |
140 | | - --server-local-path "d:\\abc" |
141 | | -``` |
142 | | - |
143 | | -##### Delete a given server endpoint. |
144 | | -``` |
145 | | -az storagesync sync-group server-endpoint delete \ |
146 | | - --resource-group rg \ |
147 | | - --name server-endpoint-name \ |
148 | | - --storage-sync-service storage-sync-service-name \ |
149 | | - --sync-group-name sync-group-name |
150 | | -``` |
151 | | - |
152 | | -##### Show the properties for a given server endpoint. |
153 | | -``` |
154 | | -az storagesync sync-group server-endpoint show \ |
155 | | - --resource-group rg \ |
156 | | - --name server-endpoint-name \ |
157 | | - --storage-sync-service storage-sync-service-name \ |
158 | | - --sync-group-name sync-group-name |
159 | | -``` |
160 | | - |
161 | | -##### List all server endpoints in a sync group. |
162 | | -``` |
163 | | -az storagesync sync-group server-endpoint list \ |
164 | | - --resource-group rg \ |
165 | | - --storage-sync-service storage-sync-service-name \ |
166 | | - --sync-group-name sync-group-name |
167 | | -``` |
168 | | - |
169 | | -#### Manage registered server. |
170 | | - |
171 | | -##### Register an on-premises server to a storage sync service. |
172 | | - |
173 | | -*This command is not supported in CLI yet. You can use Azure PowerShell command [Register-AzStorageSyncServer](https://docs.microsoft.com/en-us/powershell/module/az.storagesync/register-azstoragesyncserver?view=azps-3.6.1) or [Azure File Sync Agent](https://docs.microsoft.com/en-us/azure/storage/files/storage-sync-files-deployment-guide?tabs=azure-portal#register-windows-server-with-storage-sync-service) instead.* |
174 | | - |
175 | | -##### Unregister an on-premises server from it's storage sync service. |
176 | | -``` |
177 | | -az storagesync registered-server delete \ |
178 | | - --resource-group rg \ |
179 | | - --storage-sync-service storage-sync-service-name \ |
180 | | - --server-id server-id |
181 | | -``` |
182 | | - |
183 | | -##### Show the properties for a given registered server. |
184 | | -``` |
185 | | -az storagesync registered-server show \ |
186 | | - --resource-group rg \ |
187 | | - --storage-sync-service storage-sync-service-name \ |
188 | | - --server-id server-id |
189 | | -``` |
190 | | - |
191 | | -##### List all registered servers for a given storage sync service. |
192 | | -``` |
193 | | -az storagesync registered-server list \ |
194 | | - --resource-group rg \ |
195 | | - --storage-sync-service storage-sync-service-name |
196 | | -``` |
197 | | - |
198 | | -##### Roll the storage sync server certificate used to describe the server identity to the storage sync service. |
199 | | - |
200 | | -*This command is not supported in CLI yet. You can use Azure PowerShell command [Reset-AzStorageSyncServerCertificate](https://docs.microsoft.com/en-us/powershell/module/az.storagesync/reset-azstoragesyncservercertificate?view=azps-3.6.1) instead.* |
201 | | - |
202 | | -If you have issues, please give feedback by opening an issue at https://github.com/Azure/azure-cli-extensions/issues. |
| 1 | +Microsoft Azure CLI 'storagesync' Extension |
| 2 | +========================================== |
| 3 | + |
| 4 | +This package is for the 'storagesync' extension. |
| 5 | +i.e. 'az storagesync' |
0 commit comments