-
Notifications
You must be signed in to change notification settings - Fork 492
/
volume.yml
2341 lines (2340 loc) · 118 KB
/
volume.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
### YamlMime:AzureCLIGroup
uid: az_netappfiles_volume
name: az netappfiles volume
importantNote: >-
> [!NOTE]
> This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions.
summary: |-
Manage Azure NetApp Files (ANF) Volume Resources.
description: |-
Generated Create update delete operations for Azure NetApp Files (ANF) Volumes.
status: GA
sourceType: Core and Extension
directCommands:
- uid: az_netappfiles_volume_break-file-locks
name: az netappfiles volume break-file-locks
summary: |-
Break all the file locks on a volume.
status: GA
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/netappfiles/_help.py
syntax: >-
az netappfiles volume break-file-locks [--account-name]
[--client-ip]
[--confirm {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--subscription]
[--yes]
examples:
- summary: |-
Break all the file locks on the volume
syntax: az netappfiles volume break-file-locks -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname
optionalParameters:
- name: --account-name -a
summary: |-
The name of the NetApp account.
- name: --client-ip
summary: |-
To clear file locks on a volume for a particular client.
- name: --confirm --confirm-running-disruptive-operation
defaultValue: "True"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Break-file-locks could be a disruptive operation for application as locks on the volume will be broken, if want to process, set to true.
- name: --ids
summary: |-
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
- name: --name --volume-name -n -v
summary: |-
The name of the volume.
- name: --no-wait
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Do not wait for the long-running operation to finish.
- name: --pool-name -p
summary: |-
The name of the capacity pool.
- name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --yes -y
defaultValue: "False"
summary: |-
Do not prompt for confirmation.
- uid: az_netappfiles_volume_create
name: az netappfiles volume create
summary: |-
Create or Update a volume.
description: |-
Create the specified volume within the capacity pool.
status: GA
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/netappfiles/_help.py
syntax: >-
az netappfiles volume create --account-name
--creation-token
--name
--pool-name
--resource-group
[--allowed-clients]
[--avs-data-store {Disabled, Enabled}]
[--backup-id]
[--backup-policy-id]
[--backup-vault-id]
[--ca-retrieval-policy {Default, Never, OnRead}]
[--capacity-pool-resource-id]
[--chown-mode {Restricted, Unrestricted}]
[--cifs {0, 1, f, false, n, no, t, true, y, yes}]
[--cool-access {0, 1, f, false, n, no, t, true, y, yes}]
[--coolness-period]
[--default-group-quota]
[--default-quota-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--default-user-quota]
[--delete-base-snapshot {0, 1, f, false, n, no, t, true, y, yes}]
[--enable-subvolumes {Disabled, Enabled}]
[--encryption-key-source {Microsoft.KeyVault, Microsoft.NetApp}]
[--endpoint-type {dst, src}]
[--export-policy-rules]
[--external-host-name]
[--external-server-name]
[--external-volume-name]
[--has-root-access {0, 1, f, false, n, no, t, true, y, yes}]
[--is-large-volume {0, 1, f, false, n, no, t, true, y, yes}]
[--is-restoring {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5-r {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5-rw {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5i-r {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5i-rw {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5p-r {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5p-rw {0, 1, f, false, n, no, t, true, y, yes}]
[--key-vault-private-endpoint-resource-id]
[--ldap-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--location]
[--network-features {Basic, Standard}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--placement-rules]
[--policy-enforced {0, 1, f, false, n, no, t, true, y, yes}]
[--ppg]
[--protocol-types]
[--relocation-requested {0, 1, f, false, n, no, t, true, y, yes}]
[--remote-volume-id]
[--remote-volume-region]
[--replication-schedule {_10minutely, daily, hourly}]
[--rule-index]
[--security-style {ntfs, unix}]
[--service-level {Premium, Standard, StandardZRS, Ultra}]
[--smb-access-based-enumeration {Disabled, Enabled}]
[--smb-ca {0, 1, f, false, n, no, t, true, y, yes}]
[--smb-encryption {0, 1, f, false, n, no, t, true, y, yes}]
[--smb-non-browsable {Disabled, Enabled}]
[--snapshot-dir-visible {0, 1, f, false, n, no, t, true, y, yes}]
[--snapshot-id]
[--snapshot-policy-id]
[--subnet]
[--tags]
[--throughput-mibps]
[--unix-permissions]
[--unix-read-only {0, 1, f, false, n, no, t, true, y, yes}]
[--unix-read-write {0, 1, f, false, n, no, t, true, y, yes}]
[--usage-threshold]
[--vnet]
[--volume-spec-name]
[--volume-type]
[--zones]
examples:
- summary: |-
Create an ANF volume
syntax: az netappfiles volume create -g group --account-name aname --pool-name pname --volume-name vname -l location --service-level "Premium" --usage-threshold 100 --creation-token "unique-token" --protocol-types NFSv3 --vnet myvnet --subnet-id "/subscriptions/mysubsid/resourceGroups/myrg/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/default" --rules '[{"allowed_clients":"0.0.0.0/0","rule_index":"1","unix_read_only":"true","unix_read_write":"false","cifs":"false","nfsv3":"true","nfsv41":"false"}]'
- summary: |-
Create an ANF volume with zones (Availability Zone) specified
syntax: az netappfiles volume create -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname -l westus2 --service-level premium --usage-threshold 100 --file-path "unique-file-path" --vnet myvnet --subnet mysubnet --protocol-types NFSv3 --zones zone1
- summary: |-
Create an ANF volume with CMK Encryption
syntax: az netappfiles volume create -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname -l westus2 --service-level premium --usage-threshold 100 --file-path "unique-file-path" --vnet myvnet --subnet mysubnet --protocol-types NFSv3 --network-features Standard --protocol-types NFSv4.1 --rule-index 1 --allowed-clients '10.7.0.0/24' --kerberos-enabled false --encryption-key-source Microsoft.KeyVault --kv-private-endpoint-id myPrivateEndpointId
requiredParameters:
- isRequired: true
name: --account-name -a
summary: |-
The name of the NetApp account.
- isRequired: true
name: --creation-token --file-path
summary: |-
A unique file path for the volume. Used when creating mount targets.
- isRequired: true
name: --name --volume-name -n -v
summary: |-
The name of the volume.
- isRequired: true
name: --pool-name -p
summary: |-
The name of the capacity pool.
- isRequired: true
name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
optionalParameters:
- name: --allowed-clients
summary: |-
Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --avs-data-store
defaultValue: "Disabled"
parameterValueGroup: "Disabled, Enabled"
summary: |-
Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose.
- name: --backup-id
summary: |-
Resource identifier used to identify the Backup.
- name: --backup-policy-id
summary: |-
Backup Policy Resource ID.
- name: --backup-vault-id
summary: |-
Backup Vault Resource ID.
- name: --ca-retrieval-policy --cool-access-retrieval-policy
parameterValueGroup: "Default, Never, OnRead"
summary: |-
CoolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage.
- name: --capacity-pool-resource-id --pool-resource-id
summary: |-
Pool Resource Id used in case of creating a volume through volume group.
- name: --chown-mode
parameterValueGroup: "Restricted, Unrestricted"
summary: |-
This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. Possible values include- Restricted, Unrestricted. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --cifs
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Allows CIFS protocol. Enable only for CIFS type volumes. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --cool-access
defaultValue: "False"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Specifies whether Cool Access(tiering) is enabled for the volume.
- name: --coolness-period
summary: |-
Specifies the number of days after which data that is not accessed by clients will be tiered.
- name: --default-group-quota --default-group-quota-in-ki-bs
defaultValue: "0"
summary: |-
Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
- name: --default-quota-enabled --is-def-quota-enabled --is-default-quota-enabled
defaultValue: "False"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Specifies if default quota is enabled for the volume.
- name: --default-user-quota --default-user-quota-in-ki-bs
defaultValue: "0"
summary: |-
Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
- name: --delete-base-snapshot
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false.
- name: --enable-subvolumes
defaultValue: "Disabled"
parameterValueGroup: "Disabled, Enabled"
summary: |-
Flag indicating whether subvolume operations are enabled on the volume.
- name: --encryption-key-source
defaultValue: "Microsoft.NetApp"
parameterValueGroup: "Microsoft.KeyVault, Microsoft.NetApp"
summary: |-
Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'.
- name: --endpoint-type
parameterValueGroup: "dst, src"
summary: |-
Indicates whether the local volume is the source or destination for the Volume Replication.
- name: --export-policy-rules --rules
summary: |-
Export policy rule Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
- name: --external-host-name
summary: |-
The Path to a ONTAP Host.
- name: --external-server-name
summary: |-
The name of a server on the ONTAP Host.
- name: --external-volume-name
summary: |-
The name of a volume on the server.
- name: --has-root-access
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Has root access to volume. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --is-large-volume
defaultValue: "False"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Specifies whether volume is a Large Volume or Regular Volume.
- name: --is-restoring
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Restoring.
- name: --kerberos-enabled
defaultValue: "False"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later.
- name: --kerberos5-r
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Kerberos5 Read only access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --kerberos5-rw
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Kerberos5 Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --kerberos5i-r
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Kerberos5i Readonly access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --kerberos5i-rw
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Kerberos5i Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --kerberos5p-r
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Kerberos5p Readonly access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --kerberos5p-rw
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Kerberos5p Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --key-vault-private-endpoint-resource-id --kv-private-endpoint-id
summary: |-
The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.
- name: --ldap-enabled
defaultValue: "False"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Specifies whether LDAP is enabled or not for a given NFS volume.
- name: --location -l
summary: |-
The geo-location where the resource lives When not specified, the location of the resource group will be used.
- name: --network-features
defaultValue: "Basic"
parameterValueGroup: "Basic, Standard"
summary: |-
Basic network, or Standard features available to the volume.
- name: --no-wait
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Do not wait for the long-running operation to finish.
- name: --placement-rules
summary: |-
Application specific placement rules for the particular volume Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
- name: --policy-enforced
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Policy Enforced.
- name: --ppg --proximity-placement-group
summary: |-
Proximity placement group associated with the volume.
- name: --protocol-types
summary: |-
Set of protocol types, default NFSv3, CIFS for SMB protocol Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
- name: --relocation-requested
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Has relocation been requested for this volume.
- name: --remote-volume-id --remote-volume-resource-id
summary: |-
The resource ID of the remote volume.
- name: --remote-volume-region
summary: |-
The remote region for the other end of the Volume Replication.
- name: --replication-schedule
parameterValueGroup: "_10minutely, daily, hourly"
summary: |-
Schedule.
- name: --rule-index
summary: |-
Order index. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --security-style
defaultValue: "unix"
parameterValueGroup: "ntfs, unix"
summary: |-
The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol.
- name: --service-level
defaultValue: "Premium"
parameterValueGroup: "Premium, Standard, StandardZRS, Ultra"
summary: |-
ServiceLevel.
- name: --smb-access-based-enumeration --smb-access-enumeration
parameterValueGroup: "Disabled, Enabled"
summary: |-
Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume.
- name: --smb-ca --smb-continuously-available --smb-continuously-avl
defaultValue: "False"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Enables continuously available share property for smb volume. Only applicable for SMB volume.
- name: --smb-encryption
defaultValue: "False"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later.
- name: --smb-non-browsable
parameterValueGroup: "Disabled, Enabled"
summary: |-
Enables non browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.
- name: --snapshot-dir-visible --snapshot-directory-visible
defaultValue: "True"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true).
- name: --snapshot-id
summary: |-
Resource identifier used to identify the Snapshot.
- name: --snapshot-policy-id
summary: |-
Snapshot Policy ResourceId.
- name: --subnet --subnet-id
defaultValue: "default"
summary: |-
The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes.
- name: --tags
summary: |-
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
- name: --throughput-mibps
summary: |-
Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume.
- name: --unix-permissions
summary: |-
UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.
- name: --unix-read-only
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Read only access. Exists for backwards compatibility, please use --export-policy-rules (--rules) instead.
- name: --unix-read-write
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --usage-threshold
defaultValue: "100"
summary: |-
Maximum storage quota allowed for a file system in GiB.
- name: --vnet
summary: |-
Name or Resource ID of the vnet. If you want to use a vnet in other resource group, please provide the Resource ID instead of the name of the vnet.
- name: --volume-spec-name
summary: |-
Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log.
- name: --volume-type
summary: |-
What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection.
- name: --zones
summary: |-
Availability Zone Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
- uid: az_netappfiles_volume_create(netappfiles-preview)
name: az netappfiles volume create
extensionSuffix: netappfiles-preview
summary: |-
Create or Update a volume.
description: |-
Create the specified volume within the capacity pool.
status: Preview
isPreview: true
previewOrExperimentalInfo: 'This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus'
sourceType: Extension
syntax: >-
az netappfiles volume create --account-name
--creation-token
--name
--pool-name
--resource-group
--vnet
[--accept-grow-capacity-pool-for-short-term-clone-split {Accepted, Declined}]
[--allowed-clients]
[--avs-data-store {Disabled, Enabled}]
[--backup-id]
[--backup-policy-id]
[--backup-vault-id]
[--ca-retrieval-policy {Default, Never, OnRead}]
[--capacity-pool-resource-id]
[--chown-mode {Restricted, Unrestricted}]
[--cifs {0, 1, f, false, n, no, t, true, y, yes}]
[--cool-access {0, 1, f, false, n, no, t, true, y, yes}]
[--coolness-period]
[--default-group-quota]
[--default-quota-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--default-user-quota]
[--delete-base-snapshot {0, 1, f, false, n, no, t, true, y, yes}]
[--enable-subvolumes {Disabled, Enabled}]
[--encryption-key-source {Microsoft.KeyVault, Microsoft.NetApp}]
[--endpoint-type {dst, src}]
[--export-policy-rules]
[--has-root-access {0, 1, f, false, n, no, t, true, y, yes}]
[--is-large-volume {0, 1, f, false, n, no, t, true, y, yes}]
[--is-restoring {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5-r {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5-rw {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5i-r {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5i-rw {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5p-r {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5p-rw {0, 1, f, false, n, no, t, true, y, yes}]
[--key-vault-private-endpoint-resource-id]
[--language {ar, ar.utf-8, c, c.utf-8, cs, cs.utf-8, da, da.utf-8, de, de.utf-8, en, en-us, en-us.utf-8, en.utf-8, es, es.utf-8, fi, fi.utf-8, fr, fr.utf-8, he, he.utf-8, hr, hr.utf-8, hu, hu.utf-8, it, it.utf-8, ja, ja-jp.932, ja-jp.932.utf-8, ja-jp.pck, ja-jp.pck-v2, ja-jp.pck-v2.utf-8, ja-jp.pck.utf-8, ja-v1, ja-v1.utf-8, ja.utf-8, ko, ko.utf-8, nl, nl.utf-8, no, no.utf-8, pl, pl.utf-8, pt, pt.utf-8, ro, ro.utf-8, ru, ru.utf-8, sk, sk.utf-8, sl, sl.utf-8, sv, sv.utf-8, tr, tr.utf-8, utf8mb4, zh, zh-tw, zh-tw.big5, zh-tw.big5.utf-8, zh-tw.utf-8, zh.gbk, zh.gbk.utf-8, zh.utf-8}]
[--ldap-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--location]
[--network-features {Basic, Standard}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--placement-rules]
[--policy-enforced {0, 1, f, false, n, no, t, true, y, yes}]
[--ppg]
[--protocol-types]
[--relocation-requested {0, 1, f, false, n, no, t, true, y, yes}]
[--remote-path]
[--remote-volume-id]
[--remote-volume-region]
[--replication-schedule {_10minutely, daily, hourly}]
[--rule-index]
[--security-style {ntfs, unix}]
[--service-level {Premium, Standard, StandardZRS, Ultra}]
[--smb-access-based-enumeration {Disabled, Enabled}]
[--smb-ca {0, 1, f, false, n, no, t, true, y, yes}]
[--smb-encryption {0, 1, f, false, n, no, t, true, y, yes}]
[--smb-non-browsable {Disabled, Enabled}]
[--snapshot-dir-visible {0, 1, f, false, n, no, t, true, y, yes}]
[--snapshot-id]
[--snapshot-policy-id]
[--subnet]
[--tags]
[--throughput-mibps]
[--unix-permissions]
[--unix-read-only {0, 1, f, false, n, no, t, true, y, yes}]
[--unix-read-write {0, 1, f, false, n, no, t, true, y, yes}]
[--usage-threshold]
[--volume-spec-name]
[--volume-type]
[--zones]
examples:
- summary: |-
Create an ANF volume
syntax: az netappfiles volume create -g group --account-name aname --pool-name pname --volume-name vname -l location --service-level "Premium" --usage-threshold 100 --creation-token "unique-token" --protocol-types NFSv3 --vnet myvnet --subnet-id "/subscriptions/mysubsid/resourceGroups/myrg/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/default" --rules '[{"allowed_clients":"0.0.0.0/0","rule_index":"1","unix_read_only":"true","unix_read_write":"false","cifs":"false","nfsv3":"true","nfsv41":"false"}]'
- summary: |-
Create an ANF volume with zones (Availability Zone) specified
syntax: az netappfiles volume create -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname -l westus2 --service-level premium --usage-threshold 100 --file-path "unique-file-path" --vnet myvnet --subnet mysubnet --protocol-types NFSv3 --zones zone1
- summary: |-
Create an ANF volume with CMK Encryption
syntax: az netappfiles volume create -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname -l westus2 --service-level premium --usage-threshold 100 --file-path "unique-file-path" --vnet myvnet --subnet mysubnet --protocol-types NFSv3 --network-features Standard --protocol-types NFSv4.1 --rule-index 1 --allowed-clients '10.7.0.0/24' --kerberos-enabled false --encryption-key-source Microsoft.KeyVault --kv-private-endpoint-id myPrivateEndpointId
requiredParameters:
- isRequired: true
name: --account-name -a
summary: |-
The name of the NetApp account.
- isRequired: true
name: --creation-token --file-path
summary: |-
A unique file path for the volume. Used when creating mount targets.
- isRequired: true
name: --name --volume-name -n -v
summary: |-
The name of the volume.
- isRequired: true
name: --pool-name -p
summary: |-
The name of the capacity pool.
- isRequired: true
name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- isRequired: true
name: --vnet
summary: |-
Name or Resource ID of the vnet. If you want to use a vnet in other resource group or subscription, please provide the Resource ID instead of the name of the vnet.
optionalParameters:
- name: --accept-grow-capacity-pool-for-short-term-clone-split --grow-pool-clone-split
parameterValueGroup: "Accepted, Declined"
summary: |-
While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted.
- name: --allowed-clients
summary: |-
Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --avs-data-store
defaultValue: "Disabled"
parameterValueGroup: "Disabled, Enabled"
summary: |-
Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose.
- name: --backup-id
summary: |-
Resource identifier used to identify the Backup.
- name: --backup-policy-id
summary: |-
Backup Policy Resource ID.
- name: --backup-vault-id
summary: |-
Backup Vault Resource ID.
- name: --ca-retrieval-policy --cool-access-retrieval-policy
parameterValueGroup: "Default, Never, OnRead"
summary: |-
CoolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage.
- name: --capacity-pool-resource-id --pool-resource-id
summary: |-
Pool Resource Id used in case of creating a volume through volume group.
- name: --chown-mode
parameterValueGroup: "Restricted, Unrestricted"
summary: |-
This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. Possible values include- Restricted, Unrestricted. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --cifs
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Allows CIFS protocol. Enable only for CIFS type volumes. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --cool-access
defaultValue: "False"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Specifies whether Cool Access(tiering) is enabled for the volume.
- name: --coolness-period
summary: |-
Specifies the number of days after which data that is not accessed by clients will be tiered.
- name: --default-group-quota --default-group-quota-in-ki-bs
defaultValue: "0"
summary: |-
Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
- name: --default-quota-enabled --is-def-quota-enabled --is-default-quota-enabled
defaultValue: "False"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Specifies if default quota is enabled for the volume.
- name: --default-user-quota --default-user-quota-in-ki-bs
defaultValue: "0"
summary: |-
Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
- name: --delete-base-snapshot
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false.
- name: --enable-subvolumes
defaultValue: "Disabled"
parameterValueGroup: "Disabled, Enabled"
summary: |-
Flag indicating whether subvolume operations are enabled on the volume.
- name: --encryption-key-source
defaultValue: "Microsoft.NetApp"
parameterValueGroup: "Microsoft.KeyVault, Microsoft.NetApp"
summary: |-
Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'.
- name: --endpoint-type
parameterValueGroup: "dst, src"
summary: |-
Indicates whether the local volume is the source or destination for the Volume Replication.
- name: --export-policy-rules --rules
summary: |-
Export policy rule Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
- name: --has-root-access
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Has root access to volume. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --is-large-volume
defaultValue: "False"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Specifies whether volume is a Large Volume or Regular Volume.
- name: --is-restoring
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Restoring.
- name: --kerberos-enabled
defaultValue: "False"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later.
- name: --kerberos5-r
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Kerberos5 Read only access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --kerberos5-rw
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Kerberos5 Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --kerberos5i-r
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Kerberos5i Readonly access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --kerberos5i-rw
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Kerberos5i Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --kerberos5p-r
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Kerberos5p Readonly access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --kerberos5p-rw
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Kerberos5p Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --key-vault-private-endpoint-resource-id --kv-private-endpoint-id
summary: |-
The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.
- name: --language
parameterValueGroup: "ar, ar.utf-8, c, c.utf-8, cs, cs.utf-8, da, da.utf-8, de, de.utf-8, en, en-us, en-us.utf-8, en.utf-8, es, es.utf-8, fi, fi.utf-8, fr, fr.utf-8, he, he.utf-8, hr, hr.utf-8, hu, hu.utf-8, it, it.utf-8, ja, ja-jp.932, ja-jp.932.utf-8, ja-jp.pck, ja-jp.pck-v2, ja-jp.pck-v2.utf-8, ja-jp.pck.utf-8, ja-v1, ja-v1.utf-8, ja.utf-8, ko, ko.utf-8, nl, nl.utf-8, no, no.utf-8, pl, pl.utf-8, pt, pt.utf-8, ro, ro.utf-8, ru, ru.utf-8, sk, sk.utf-8, sl, sl.utf-8, sv, sv.utf-8, tr, tr.utf-8, utf8mb4, zh, zh-tw, zh-tw.big5, zh-tw.big5.utf-8, zh-tw.utf-8, zh.gbk, zh.gbk.utf-8, zh.utf-8"
summary: |-
Language.
- name: --ldap-enabled
defaultValue: "False"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Specifies whether LDAP is enabled or not for a given NFS volume.
- name: --location -l
summary: |-
The geo-location where the resource lives When not specified, the location of the resource group will be used.
- name: --network-features
defaultValue: "Basic"
parameterValueGroup: "Basic, Standard"
summary: |-
Basic network, or Standard features available to the volume.
- name: --no-wait
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Do not wait for the long-running operation to finish.
- name: --placement-rules
summary: |-
Application specific placement rules for the particular volume Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
- name: --policy-enforced
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Policy Enforced.
- name: --ppg --proximity-placement-group
summary: |-
Proximity placement group associated with the volume.
- name: --protocol-types
summary: |-
Set of protocol types, default NFSv3, CIFS for SMB protocol Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
- name: --relocation-requested
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Has relocation been requested for this volume.
- name: --remote-path
summary: |-
The full path to a volume that is to be migrated into ANF. Required for Migration volumes Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
- name: --remote-volume-id --remote-volume-resource-id
summary: |-
The resource ID of the remote volume.
- name: --remote-volume-region
summary: |-
The remote region for the other end of the Volume Replication.
- name: --replication-schedule
parameterValueGroup: "_10minutely, daily, hourly"
summary: |-
Schedule.
- name: --rule-index
summary: |-
Order index. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --security-style
defaultValue: "unix"
parameterValueGroup: "ntfs, unix"
summary: |-
The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol.
- name: --service-level
defaultValue: "Premium"
parameterValueGroup: "Premium, Standard, StandardZRS, Ultra"
summary: |-
ServiceLevel.
- name: --smb-access-based-enumeration --smb-access-enumeration
parameterValueGroup: "Disabled, Enabled"
summary: |-
Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume.
- name: --smb-ca --smb-continuously-available --smb-continuously-avl
defaultValue: "False"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Enables continuously available share property for smb volume. Only applicable for SMB volume.
- name: --smb-encryption
defaultValue: "False"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later.
- name: --smb-non-browsable
parameterValueGroup: "Disabled, Enabled"
summary: |-
Enables non browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.
- name: --snapshot-dir-visible --snapshot-directory-visible
defaultValue: "True"
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true).
- name: --snapshot-id
summary: |-
Resource identifier used to identify the Snapshot.
- name: --snapshot-policy-id
summary: |-
Snapshot Policy ResourceId.
- name: --subnet --subnet-id
defaultValue: "default"
summary: |-
The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes.
- name: --tags
summary: |-
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
- name: --throughput-mibps
summary: |-
Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume.
- name: --unix-permissions
summary: |-
UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.
- name: --unix-read-only
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Read only access. Exists for backwards compatibility, please use --export-policy-rules (--rules) instead.
- name: --unix-read-write
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
- name: --usage-threshold
defaultValue: "100"
summary: |-
Maximum storage quota allowed for a file system in GiB.
- name: --volume-spec-name
summary: |-
Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log.
- name: --volume-type
summary: |-
What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone.
- name: --zones
summary: |-
Availability Zone Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
- uid: az_netappfiles_volume_delete
name: az netappfiles volume delete
summary: |-
Delete the specified volume.
status: GA
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/netappfiles/_help.py
syntax: >-
az netappfiles volume delete [--account-name]
[--force {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--subscription]
[--yes]
examples:
- summary: |-
Delete an ANF volume
syntax: az netappfiles volume delete -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname
optionalParameters:
- name: --account-name -a
summary: |-
The name of the NetApp account.
- name: --force --force-delete
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
An option to force delete the volume. Will cleanup resources connected to the particular volume.
- name: --ids
summary: |-
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
- name: --name --volume-name -n -v
summary: |-
The name of the volume.
- name: --no-wait
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Do not wait for the long-running operation to finish.
- name: --pool-name -p
summary: |-
The name of the capacity pool.
- name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --yes -y
defaultValue: "False"
summary: |-
Do not prompt for confirmation.
- uid: az_netappfiles_volume_delete(netappfiles-preview)
name: az netappfiles volume delete
extensionSuffix: netappfiles-preview
summary: |-
Delete the specified volume.
status: Preview
isPreview: true
previewOrExperimentalInfo: 'This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus'
sourceType: Extension
syntax: >-
az netappfiles volume delete [--account-name]
[--force {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--subscription]
[--yes]
examples:
- summary: |-
Delete an ANF volume
syntax: az netappfiles volume delete -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname
optionalParameters:
- name: --account-name -a
summary: |-
The name of the NetApp account.
- name: --force --force-delete
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
An option to force delete the volume. Will cleanup resources connected to the particular volume.
- name: --ids
summary: |-
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
- name: --name --volume-name -n -v
summary: |-
The name of the volume.
- name: --no-wait
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Do not wait for the long-running operation to finish.
- name: --pool-name -p
summary: |-
The name of the capacity pool.
- name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --yes -y
defaultValue: "False"
summary: |-
Do not prompt for confirmation.
- uid: az_netappfiles_volume_finalize-relocation
name: az netappfiles volume finalize-relocation
summary: |-
Finalizes the relocation of the volume and cleans up the old volume.
status: GA
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/netappfiles/_help.py
syntax: >-
az netappfiles volume finalize-relocation [--account-name]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--subscription]
examples:
- summary: |-
Finalizes the relocation of the volume and cleans up the old volume
syntax: az netappfiles volume finalize-relocation -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname
optionalParameters:
- name: --account-name -a
summary: |-
The name of the NetApp account.
- name: --ids
summary: |-
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
- name: --name --volume-name -n -v
summary: |-
The name of the volume.
- name: --no-wait
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Do not wait for the long-running operation to finish.
- name: --pool-name -p
summary: |-
The name of the capacity pool.
- name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_netappfiles_volume_get-groupid-list-for-ldapuser
name: az netappfiles volume get-groupid-list-for-ldapuser
summary: |-
Returns the list of group Ids for a specific LDAP User.
status: GA
sourceType: Core
editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/netappfiles/_help.py
syntax: >-
az netappfiles volume get-groupid-list-for-ldapuser --username
[--account-name]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--subscription]
examples:
- summary: |-
Get Group Id List for LDAP User myuser
syntax: az netappfiles volume get-groupid-list-for-ldapuser -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname --username myuser
requiredParameters:
- isRequired: true
name: --username
summary: |-
Username is required to fetch the group to which user is part of.
optionalParameters:
- name: --account-name -a
summary: |-
The name of the NetApp account.
- name: --ids
summary: |-
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
- name: --name --volume-name -n -v
summary: |-
The name of the volume.
- name: --no-wait
parameterValueGroup: "0, 1, f, false, n, no, t, true, y, yes"
summary: |-
Do not wait for the long-running operation to finish.
- name: --pool-name -p
summary: |-
The name of the capacity pool.
- name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.