Compute/Microsoft.WindowsAzure.Commands.dll-Help.xml

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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml">
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Add-AzureAccount</command:name>
      <maml:description>
        <maml:para>Adds the Azure account to Windows PowerShell</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>Add</command:verb>
      <command:noun>AzureAccount</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para>The Add-AzureAccount cmdlet makes your Azure account and its subscriptions available in Windows PowerShell. It's like logging into your Azure account in Windows PowerShell. To log out of the account, use the Remove-AzureAccount cmdlet.</maml:para> <maml:para>Add-AzureAccount downloads information about your Azure account and saves it in a subscription data file in your roaming user profile. It also gets an access token that allows Windows PowerShell to access your Azure account on your behalf. When the command completes, you can manage your Azure account in Windows PowerShell.</maml:para> <maml:para> There are two different ways to make your Azure account available to Windows PowerShell. You can use the Add-AzureAccount cmdlet, which uses Azure Active Directory (Azure AD) authentication access tokens, or Import-AzurePublishSettingsFile, which uses a management certificate. For guidance on which method to use, see "<maml:navigationLink><maml:linkText>How to: Connect to your subscription</maml:linkText><maml:uri></maml:uri></maml:navigationLink>" (http://azure.microsoft.com/en-us/documentation/articles/install-configure-powershell/#Connect). </maml:para> <maml:para>When you run Add-AzureAccount, it displays an interactive window that prompts you to sign into your Azure account. This sign-in is valid until the access token expires. When it expires, cmdlets that require access to your account prompt you to run Add-AzureAccount again.</maml:para> <maml:para>If you have a Microsoft Organizational account, you can use the -Credential parameter to add the subscriptions associated with your account to Windows PowerShell without an interactive dialog.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Add-AzureAccount</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>Credential</maml:name>
          <maml:description>
            <maml:para>The username and password account credentials used to authenticate with Azure Active Directory.  The credentials must be for a Microsoft Organizational account and not another kind of Microsoft account.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
          <maml:name>Environment</maml:name>
          <maml:description>
            <maml:para>Specifies an Azure environment for  the user account. This parameter is optional. The default is the AzureCloud environment.</maml:para>
            <maml:para>
              An Azure environment an independent deployment of Microsoft Azure, such as AzureCloud for global Azure and AzureChinaCloud for Azure operated by 21Vianet in China. You can also create on-premises Azure environments by using Azure Pack and the WAPack cmdlets. For more information, see <maml:navigationLink><maml:linkText>Azure Pack</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.
            </maml:para>
            <maml:para>To get the available Azure environments, use the Get-AzureEnvironment cmdlet. To add an environment, use the Add-AzureEnvironment cmdlet.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
          <maml:name>SubscriptionDataFile</maml:name>
          <maml:description>
            <maml:para>Specifies an alternate location for the subscription data file. This parameter is optional. By default, the subscription data file is saved in your roaming user profile.</maml:para>
            <maml:para>If you use this parameter to specify an alternate location for the subscription data file, be sure to use the SubscriptionDataFile parameters of cmdlets that access your account. Otherwise, the cmdlets look for your account data in the default location.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>Credential</maml:name>
        <maml:description>
          <maml:para>The username and password account credentials used to authenticate with Azure Active Directory.  The credentials must be for a Microsoft Organizational account and not another kind of Microsoft account.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue>
        <dev:type>
          <maml:name>PSCredential</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
        <maml:name>Environment</maml:name>
        <maml:description>
          <maml:para>Specifies an Azure environment for  the user account. This parameter is optional. The default is the AzureCloud environment.</maml:para>
          <maml:para>
            An Azure environment an independent deployment of Microsoft Azure, such as AzureCloud for global Azure and AzureChinaCloud for Azure operated by 21Vianet in China. You can also create on-premises Azure environments by using Azure Pack and the WAPack cmdlets. For more information, see <maml:navigationLink><maml:linkText>Azure Pack</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.
          </maml:para>
          <maml:para>To get the available Azure environments, use the Get-AzureEnvironment cmdlet. To add an environment, use the Add-AzureEnvironment cmdlet.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
        <maml:name>SubscriptionDataFile</maml:name>
        <maml:description>
          <maml:para>Specifies an alternate location for the subscription data file. This parameter is optional. By default, the subscription data file is saved in your roaming user profile.</maml:para>
          <maml:para>If you use this parameter to specify an alternate location for the subscription data file, be sure to use the SubscriptionDataFile parameters of cmdlets that access your account. Otherwise, the cmdlets look for your account data in the default location.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>You cannot pipe input to this cmdlet</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>None</maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>This cmdlet does not return any output.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <maml:alertSet>
      <maml:title />
      <maml:alert>
        <maml:para>Add-AzureAccount (and the Azure AD authentication method) takes precedence over Import-AzurePublishSettings (and the management certificate method). If you use Add-AzureAccount even once on your account, the Azure AD authentication method is used and the management certificate is ignored. To remove the Azure AD token and restore the management certificate method, use the Remove-AzureAccount cmdlet. For more information, type: Get-Help Remove-AzureAccount.</maml:para>
        <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para>
      </maml:alert>
      <maml:alert>
        <maml:para>The error, "Your credentials have expired. Please use Add-AzureAccount to log in again." indicates that your access token is expired and Windows PowerShell cannot access your Azure account. To restore access to your account, run Add-AzureAccount again.</maml:para>
      </maml:alert>
      <maml:alert>
        <maml:para>The Azure PowerShell account and subscription cmdlets get their data from the  subscription data file, not from the live Azure account. If you change your account or subscriptions outside of Windows PowerShell, such as by using the Azure Management Portal, run Add-AzureAccount again to refresh the subscription data file.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>---------- Example 1: Add an account ----------</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>
          PS C:\&gt;Add-AzureAccount

        </dev:code>
        <dev:remarks>
          <maml:para>This command adds an Azure account to Windows PowerShell. When you run the command, a windows pops up to request the user name and password of the account. </maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>---------- Example 2: Use an alternate subscription data file ----------</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>
          PS C:\&gt;Add-AzureAccount -SubscriptionDataFile C:\Testing\SDF.xml
        </dev:code>
        <dev:remarks>
          <maml:para>This command uses the SubscriptionDataFile parameter to direct Add-AzureAccount to store the account data in the C:\Testing\SDF.xml file, instead of the default file.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>---------- Example 3: Add a Microsoft Organizational account using -Credential ----------</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>
          PS C:\&gt;$credential = Get-Credential
          PS C:\&gt;Add-AzureAccount -Credential $credential
        </dev:code>
        <dev:remarks>
          <maml:para>This command uses the Credential parameter to provide AAD authentication information on the command line, rather than using the pop-up dialog for AAD authentication.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>---------- Example 4: Add an account in Azure China ----------</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>
          PS C:\&gt;Add-AzureAccount -Environment AzureChinaCloud
        </dev:code>
        <dev:remarks>
          <maml:para>This command uses the Environment parameter to add an Azure China account to Windows PowerShell. When you run the command, a windows pops up to request the user name and password of the account.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
    </command:examples>
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version:</maml:linkText>
        <maml:uri>http://go.microsoft.com/fwlink/?LinkID=397618</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Add-AzureEnvironment</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Get-AzureEnvironment</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Get-AzureAccount</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Remove-AzureAccount</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
    </maml:relatedLinks>
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Get-AzureAccount</command:name>
      <maml:description>
        <maml:para>Gets Azure accounts that are available to Azure PowerShell.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>Get</command:verb>
      <command:noun>AzureAccount</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para>The Get-AzureAccount cmdlet gets the Azure accounts that are available to Windows PowerShell. To make your accounts available to Windows PowerShell, run the Add-AzureAccount or Import-PublishSettingsFile cmdlets.</maml:para>
      <maml:para>The Get-AzureEnvironment cmdlet gets environments from your subscription data file, not from Azure. If the subscription data file is outdated, run the Add-AzureAccount or Import-PublishSettingsFile cmdlets to refresh it.This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureAccount</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Gets only the specified account. Type the account name. The Name value is case-sensitive. Wildcards are not permitted. The default is all accounts that are available to Windows PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies the path and filename of an alternate subscription data file. This parameter is optional. By default, Get-AzureAccount gets account and subscription information from the default subscription data file in your roaming user profile. Use this parameter if you used the SubscriptionDataFile parameter in Add-AzureAccount or Import-AzurePublishSettingsFile to specify an alternate (non-default) file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Gets only the specified account. Type the account name. The Name value is case-sensitive. Wildcards are not permitted. The default is all accounts that are available to Windows PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies the path and filename of an alternate subscription data file. This parameter is optional. By default, Get-AzureAccount gets account and subscription information from the default subscription data file in your roaming user profile. Use this parameter if you used the SubscriptionDataFile parameter in Add-AzureAccount or Import-AzurePublishSettingsFile to specify an alternate (non-default) file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe input to this cmdlet</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet does not return any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all accounts</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\&gt;Get-AzureAccount Name ActiveDirectories ---- ----------------- contosoadmin@outlook.com {{ ActiveDirectoryTenantId = abcde5cd-bcc3-441a-bd86-e6a... contosotest1@outlook.com {{ ActiveDirectoryTenantId = aaeabcde-386c-4466-bf70-794... </dev:code> <dev:remarks> <maml:para>This command gets all accounts associated with the specified user.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get an account by name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\&gt;Get-AzureAccount -Name contosoadmin@outlook.com Name ActiveDirectories ---- ----------------- contosoadmin@outlook.com {{ ActiveDirectoryTenantId = abcde5cd-bcc3-441a-bd86-e6a... </dev:code> <dev:remarks> <maml:para>This command gets the ContosoAdmin account.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=397620</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureAccount</command:name> <maml:description> <maml:para>Deletes an Azure account from Windows PowerShell.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureAccount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureAccount cmdlet deletes an Azure account from your subscription data file and deletes the management certificate or access token that allows Windows PowerShell to access your account on your behalf. This cmdlet does not delete the account from Microsoft Azure, or change the actual account in any way.</maml:para> <maml:para>Using this cmdlet is a lot like logging out of your Azure account. And, if you want to log into the account again, use the Add-AzureAccount or Import-AzurePublishSettingsFile to add the account to Windows PowerShell again.</maml:para> <maml:para>You can also use Remove-AzureAccount cmdlet to change the way the Azure PowerShell cmdlets sign into your Azure account. If your account has both a management certificate from Import-AzurePublishSettingsFile and an access token from Add-AzureAccount, the Azure PowerShell cmdlets use only the access token; they ignore the management certificate. To use the management certificate, run Remove-AzureAccount. When Remove-AzureAccount finds both a management certificate and an access token, it deletes only the access token, instead of deleting the account. The management certificate is still there, so account is still available to Windows PowerShell.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Remove-AzureAccount</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="">
          <maml:name>Name</maml:name>
          <maml:description>
            <maml:para>Specifies the name of the account to remove. The parameter value is case-sensitive. Wildcard characters are not supported.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases="">
          <maml:name>Force</maml:name>
          <maml:description>
            <maml:para>Suppresses the confirmation prompt. By default, Remove-AzureAccount prompts you before deleting the account from Windows PowerShell.</maml:para>
          </maml:description>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="">
          <maml:name>PassThru</maml:name>
          <maml:description>
            <maml:para>Returns True ($true) if the operation succeeded and False ($false) if it failed. By default, the cmdlet does not return any output.</maml:para>
          </maml:description>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
          <maml:name>SubscriptionDataFile</maml:name>
          <maml:description>
            <maml:para>Specifies the path and filename of an alternate subscription data file. This parameter is optional. By default, Get-AzureAccount gets account and subscription information from the default subscription data file in your roaming user profile. Use this parameter if you used the SubscriptionDataFile parameter in Add-AzureAccount or Import-AzurePublishSettingsFile to specify an alternate (non-default) file.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
          <maml:name>Confirm</maml:name>
          <maml:description>
            <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
          </maml:description>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
          <maml:name>WhatIf</maml:name>
          <maml:description>
            <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
          </maml:description>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases="">
        <maml:name>Force</maml:name>
        <maml:description>
          <maml:para>Suppresses the confirmation prompt. By default, Remove-AzureAccount prompts you before deleting the account from Windows PowerShell.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="">
        <maml:name>Name</maml:name>
        <maml:description>
          <maml:para>Specifies the name of the account to remove. The parameter value is case-sensitive. Wildcard characters are not supported.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="">
        <maml:name>PassThru</maml:name>
        <maml:description>
          <maml:para>Returns True ($true) if the operation succeeded and False ($false) if it failed. By default, the cmdlet does not return any output.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
        <maml:name>SubscriptionDataFile</maml:name>
        <maml:description>
          <maml:para>Specifies the path and filename of an alternate subscription data file. This parameter is optional. By default, Get-AzureAccount gets account and subscription information from the default subscription data file in your roaming user profile. Use this parameter if you used the SubscriptionDataFile parameter in Add-AzureAccount or Import-AzurePublishSettingsFile to specify an alternate (non-default) file.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
        <maml:name>Confirm</maml:name>
        <maml:description>
          <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>false</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
        <maml:name>WhatIf</maml:name>
        <maml:description>
          <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>false</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>None or System.Boolean</maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>If you use the PassThru parameter, this cmdlet returns a Boolean value. Otherwise, it does not return any output.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <command:examples>
      <command:example>
        <maml:title>Example 1: Delete an account</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>
          PS C:\&gt;Remove-AzureAccount -Name admin@contoso.com

        </dev:code>
        <dev:remarks>
          <maml:para>This command deletes the admin@contoso.com from your subscription data file. When the command completes, the account is no longer available to Windows PowerShell.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
    </command:examples>
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version:</maml:linkText>
        <maml:uri>http://go.microsoft.com/fwlink/?LinkID=397625</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Add-AzureAccount</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Get-AzureAccount</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
    </maml:relatedLinks>
    <maml:alertSet>
      <maml:alert>
        <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para>
      </maml:alert>
    </maml:alertSet>
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Get-AzureEnvironment</command:name>
      <maml:description>
        <maml:para>Gets Azure environments</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>Get</command:verb>
      <command:noun>AzureEnvironment</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para>The Get-AzureEnvironment cmdlet gets the Azure environments that are available to Windows PowerShell.</maml:para>
      <maml:para>
        An Azure environment an independent deployment of Microsoft Azure, such as AzureCloud for global Azure and AzureChinaCloud for Azure operated by 21Vianet in China. You can also create on-premises Azure environments by using Azure Pack and the WAPack cmdlets. For more information, see <maml:navigationLink><maml:linkText>Azure Pack</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.microsoft.com/en-us/server-cloud/products/windows-azure-pack/default.aspx).
      </maml:para>
      <maml:para>The Get-AzureEnvironment cmdlet gets environments from your subscription data file, not from Azure. If the subscription data file is outdated, run the Add-AzureAccount or Import-PublishSettingsFile cmdlet to refresh it.</maml:para>
      <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureEnvironment</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Gets only the specified environment. Type the environment name. The parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Gets only the specified environment. Type the environment name. The parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>By default, Get-AzureEnvironment returns a custom object.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>When you run Get-AzureEnvironment with the Name parameter, it returns a WindowsAzureEnvironment object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all environments</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\&gt;Get-AzureEnvironment EnvironmentName ServiceEndpoint ResourceManagerEndpoint PublishSettingsFileUrl --------------- --------------- ----------------------- ---------------------- AzureCloud https://management.core.wi... https://management.azure.com/ http://go.microsoft.com/fw... AzureChinaCloud https://management.core.ch... https://not-supported-serv... http://go.microsoft.com/fw... </dev:code> <dev:remarks> <maml:para>This command gets all environments that are available to Windows PowerShell.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get an environment by name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\&gt;Get-AzureEnvironment -Name AzureCloud Name : AzureCloud PublishSettingsFileUrl : http://go.microsoft.com/fwlink/?LinkID=301775 ServiceEndpoint : https://management.core.windows.net/ ResourceManagerEndpoint : https://management.azure.com/ ManagementPortalUrl : http://go.microsoft.com/fwlink/?LinkId=254433 ActiveDirectoryEndpoint : https://login.windows.net/ ActiveDirectoryCommonTenantId : common StorageEndpointSuffix : core.windows.net StorageBlobEndpointFormat : {0}://{1}.blob.core.windows.net/ StorageQueueEndpointFormat : {0}://{1}.queue.core.windows.net/ StorageTableEndpointFormat : {0}://{1}.table.core.windows.net/ GalleryEndpoint : https://gallery.azure.com/ </dev:code> <dev:remarks> <maml:para>This example gets the AzureCloud environment.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get all properties of all environments</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\&gt;Get-AzureEnvironment | ForEach-Object {Get-AzureEnvironment -Name $_.EnvironmentName} </dev:code> <dev:remarks> <maml:para>This command gets all properties of all environments.</maml:para> <maml:para>The command uses the Get-AzureEnvironment cmdlet to get all Azure environments for this account. Then, it uses the Foreach-Object cmdlet to run a Get-AzureEnvironment command with the Name parameter on each environment. The value of the Name parameter is the EnvironmentName property of each environment.</maml:para> <maml:para>Without parameters, Get-AzureEnvironment gets only selected properties of an environment.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=397621</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-AzureEnvironment</command:name> <maml:description> <maml:para>Creates an Azure environment</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureEnvironment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-AzureEnvironment cmdlet creates a new custom Azure account environment and saves it in your roaming user profile. The cmdlet returns an object that represents the new environment. When the command completes, you can use the environment in Windows PowerShell.</maml:para> <maml:para> An Azure environment an independent deployment of Microsoft Azure, such as AzureCloud for global Azure and AzureChinaCloud for Azure operated by 21Vianet in China. You can also create on-premises Azure environments by using Azure Pack and the WAPack cmdlets. For more information, see <maml:navigationLink><maml:linkText>Azure Pack</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.microsoft.com/en-us/server-cloud/products/windows-azure-pack/default.aspx). </maml:para> <maml:para>Only the Name parameter of this cmdlet is mandatory. If you omit a parameter, its value is null ($null), and the service that uses that endpoint might not function properly. To add or change the value of an environment property, use the Set-AzureEnvironment cmdlet.</maml:para> <maml:para>NOTE: Changing your environment can cause your account to fail. Typically, environments are added only for testing or troubleshooting.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Add-AzureEnvironment</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="">
          <maml:name>Name</maml:name>
          <maml:description>
            <maml:para>Specifies a name for the environment. This parameter is required. Do not use the names of the default environments, AzureCloud and AzureChinaCloud.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="">
          <maml:name>PublishSettingsFileUrl</maml:name>
          <maml:description>
            <maml:para>Specifies the URL of the publish settings files for your account. An Azure publish settings file is an XML file that contains information about your account and a management certificate that allows Windows PowerShell to sign into your Azure account on your behalf.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="">
          <maml:name>ServiceEndpoint</maml:name>
          <maml:description>
            <maml:para>Specifies the URL of the Azure service endpoint. The Azure service endpoint determines whether your application is managed by the global Azure platform, Azure operated by 21Vianet in China, or a private Azure installation.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="">
          <maml:name>ManagementPortalUrl</maml:name>
          <maml:description>
            <maml:para>Specifies the URL of the Azure Management Portal in the new environment.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases="">
          <maml:name>StorageEndpoint</maml:name>
          <maml:description>
            <maml:para>Specifies the default endpoint of storage services in the new environment.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="">
          <maml:name>ActiveDirectoryEndpoint</maml:name>
          <maml:description>
            <maml:para>Specifies the endpoint for Azure Active Directory authentication in the new environment.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="">
          <maml:name>ResourceManagerEndpoint</maml:name>
          <maml:description>
            <maml:para>
              Specifies the endpoint for Azure Resource Manager data, including data about resource groups associated with the account. For more information about Azure Resource Manager, see <maml:navigationLink><maml:linkText>Azure Resource Manager Cmdlets</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394765) and  <maml:navigationLink><maml:linkText>Using Windows PowerShell with Resource Manager</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394767).
            </maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="8" aliases="">
          <maml:name>GalleryEndpoint</maml:name>
          <maml:description>
            <maml:para>
              Specifies the endpoint for the Azure Resource Manager gallery, which stores resource group gallery templates.
            </maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="">
        <maml:name>ActiveDirectoryEndpoint</maml:name>
        <maml:description>
          <maml:para>Specifies the endpoint for Azure Active Directory authentication in the new environment.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="8" aliases="">
        <maml:name>GalleryEndpoint</maml:name>
        <maml:description>
          <maml:para>
            Specifies the endpoint for the Azure Resource Manager gallery, which stores resource group gallery templates.
          </maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="">
        <maml:name>ManagementPortalUrl</maml:name>
        <maml:description>
          <maml:para>Specifies the URL of the Azure Management Portal in the new environment.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="">
        <maml:name>Name</maml:name>
        <maml:description>
          <maml:para>Specifies a name for the environment. This parameter is required. Do not use the names of the default environments, AzureCloud and AzureChinaCloud.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="">
        <maml:name>PublishSettingsFileUrl</maml:name>
        <maml:description>
          <maml:para>Specifies the URL of the publish settings files for your account. An Azure publish settings file is an XML file that contains information about your account and a management certificate that allows Windows PowerShell to sign into your Azure account on your behalf.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="">
        <maml:name>ResourceManagerEndpoint</maml:name>
        <maml:description>
          <maml:para>
            Specifies the endpoint for Azure Resource Manager data, including data about resource groups associated with the account. For more information about Azure Resource Manager, see <maml:navigationLink><maml:linkText>Azure Resource Manager Cmdlets</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394765) and  <maml:navigationLink><maml:linkText>Using Windows PowerShell with Resource Manager</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394767).
          </maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="">
        <maml:name>ServiceEndpoint</maml:name>
        <maml:description>
          <maml:para>Specifies the URL of the Azure service endpoint. The Azure service endpoint determines whether your application is managed by the global Azure platform, Azure operated by 21Vianet in China, or a private Azure installation.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases="">
        <maml:name>StorageEndpoint</maml:name>
        <maml:description>
          <maml:para>Specifies the default endpoint of storage services in the new environment.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment</maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>
          </maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <command:examples>
      <command:example>
        <maml:title>Example 1: Add an Azure environment</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>
          PS C:\&gt;Add-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl https://contoso.com/fwlink/?LinkID=101 -ServiceEndpoint https://contoso.com/fwlink/?LinkID=102
          Name                          : ContosoEnv

          PublishSettingsFileUrl        : https://contoso.com/fwlink/?LinkID=101

          ServiceEndpoint               : https://contoso.com/fwlink/?LinkID=102

          ResourceManagerEndpoint       :

          ManagementPortalUrl           :

          ActiveDirectoryEndpoint       :

          ActiveDirectoryCommonTenantId :

          StorageEndpointSuffix         :

          StorageBlobEndpointFormat     :

          StorageQueueEndpointFormat    :

          StorageTableEndpointFormat    :

          GalleryEndpoint               :
        </dev:code>
        <dev:remarks>
          <maml:para>This command creates the ContosoEnv Azure environment.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
    </command:examples>
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version:</maml:linkText>
        <maml:uri>http://go.microsoft.com/fwlink/?LinkID=397619</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Get-AzureEnvironment</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Remove-AzureEnvironment</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Set-AzureEnvironment</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
    </maml:relatedLinks>
    <maml:alertSet>
      <maml:alert>
        <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para>
      </maml:alert>
    </maml:alertSet>
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Set-AzureEnvironment</command:name>
      <maml:description>
        <maml:para>Changes the properties of an Azure environment</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>Set</command:verb>
      <command:noun>AzureEnvironment</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para>The Set-AzureEnvironment cmdlet changes the properties of an Azure environment. It returns an object that represents the environment with its new property values. Use the Name parameter to identify the environment and the other parameters to change property values. You cannot use Set-AzureEnvironment to change the name of an Azure environment.</maml:para>
      <maml:para>
        An Azure environment an independent deployment of Microsoft Azure, such as AzureCloud for global Azure and AzureChinaCloud for Azure operated by 21Vianet in China. You can also create on-premises Azure environments by using Azure Pack and the WAPack cmdlets. For more information, see <maml:navigationLink><maml:linkText>Azure Pack</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.microsoft.com/en-us/server-cloud/products/windows-azure-pack/default.aspx).
      </maml:para>
      <maml:para>NOTE:  Do not change the properties of the AzureCloud or AzureChinaCloud environments. Use this cmdlet to change the values of private environments that you create.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Set-AzureEnvironment</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="">
          <maml:name>Name</maml:name>
          <maml:description>
            <maml:para>Identifies the environment that is being changed. This parameter is required. The parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="">
          <maml:name>PublishSettingsFileUrl</maml:name>
          <maml:description>
            <maml:para>Changes the URL for publish settings files in the specified environment. An Azure publish settings file is an XML file that contains information about your account and a management certificate that allows Windows PowerShell to sign into your Azure account on your behalf.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="">
          <maml:name>ServiceEndpoint</maml:name>
          <maml:description>
            <maml:para>Changes the URL of the Azure service endpoint in the specified environment. The Azure service endpoint determines whether your application is managed by the global Azure platform, Azure operated by 21Vianet in China, or a private Azure installation.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="">
          <maml:name>ManagementPortalUrl</maml:name>
          <maml:description>
            <maml:para>Changes the URL of the Azure Management Portal to the specified value.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases="">
          <maml:name>StorageEndpoint</maml:name>
          <maml:description>
            <maml:para>Changes the default endpoint of storage services in the specified environment.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="AdEndpointUrl">
          <maml:name>ActiveDirectoryEndpoint</maml:name>
          <maml:description>
            <maml:para>Changes the endpoint for Azure Active Directory authentication to the specified value.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="">
          <maml:name>ResourceManagerEndpoint</maml:name>
          <maml:description>
            <maml:para>
              Changes the endpoint for Azure Resource Manager data, including data about resource groups associated with the account. For more information about Azure Resource Manager, see <maml:navigationLink><maml:linkText>Azure Resource Manager Cmdlets</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394765) and  <maml:navigationLink><maml:linkText>Using Windows PowerShell with Resource Manager</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394767).
            </maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="8" aliases="">
          <maml:name>GalleryEndpoint</maml:name>
          <maml:description>
            <maml:para>
              Changes the endpoint for the Azure Resource Manager gallery to the specified value. The gallery endpoint is the location for resource group gallery templates.
            </maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="AdEndpointUrl">
        <maml:name>ActiveDirectoryEndpoint</maml:name>
        <maml:description>
          <maml:para>Changes the endpoint for Azure Active Directory authentication to the specified value.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="8" aliases="">
        <maml:name>GalleryEndpoint</maml:name>
        <maml:description>
          <maml:para>
            Changes the endpoint for the Azure Resource Manager gallery to the specified value. The gallery endpoint is the location for resource group gallery templates.
          </maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="">
        <maml:name>ManagementPortalUrl</maml:name>
        <maml:description>
          <maml:para>Changes the URL of the Azure Management Portal to the specified value.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="">
        <maml:name>Name</maml:name>
        <maml:description>
          <maml:para>Identifies the environment that is being changed. This parameter is required. The parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="">
        <maml:name>PublishSettingsFileUrl</maml:name>
        <maml:description>
          <maml:para>Changes the URL for publish settings files in the specified environment. An Azure publish settings file is an XML file that contains information about your account and a management certificate that allows Windows PowerShell to sign into your Azure account on your behalf.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="">
        <maml:name>ResourceManagerEndpoint</maml:name>
        <maml:description>
          <maml:para>
            Changes the endpoint for Azure Resource Manager data, including data about resource groups associated with the account. For more information about Azure Resource Manager, see <maml:navigationLink><maml:linkText>Azure Resource Manager Cmdlets</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394765) and  <maml:navigationLink><maml:linkText>Using Windows PowerShell with Resource Manager</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394767).
          </maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="">
        <maml:name>ServiceEndpoint</maml:name>
        <maml:description>
          <maml:para>Changes the URL of the Azure service endpoint in the specified environment. The Azure service endpoint determines whether your application is managed by the global Azure platform, Azure operated by 21Vianet in China, or a private Azure installation.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases="">
        <maml:name>StorageEndpoint</maml:name>
        <maml:description>
          <maml:para>Changes the default endpoint of storage services in the specified environment.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment</maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>
          </maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <command:examples>
      <command:example>
        <maml:title>Example 1: Change environment properties</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>
          PS C:\&gt;Set-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl "https://contoso.com" -StorageEndpoint "contoso.com"

        </dev:code>
        <dev:remarks>
          <maml:para>This command changes the values of the PublishSettingsFileUrl and StorageEndpoint properties of the ContosoEnv environment.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
    </command:examples>
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version:</maml:linkText>
        <maml:uri>http://go.microsoft.com/fwlink/?LinkID=397629</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Add-AzureEnvironment</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Get-AzureEnvironment</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Remove-AzureEnvironment</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
    </maml:relatedLinks>
    <maml:alertSet>
      <maml:alert>
        <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para>
      </maml:alert>
    </maml:alertSet>
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Remove-AzureEnvironment</command:name>
      <maml:description>
        <maml:para>Deletes an Azure environment from Windows PowerShell</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>Remove</command:verb>
      <command:noun>AzureEnvironment</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para>The Remove-AzureEnvironment cmdlet deletes an Azure environment from your roaming profile so Windows PowerShell can't find it. This cmdlet does not delete the environment from Microsoft Azure, or change the actual environment in any way.</maml:para> <maml:para> An Azure environment an independent deployment of Microsoft Azure, such as AzureCloud for global Azure and AzureChinaCloud for Azure operated by 21Vianet in China. You can also create on-premises Azure environments by using Azure Pack and the WAPack cmdlets. For more information, see <maml:navigationLink><maml:linkText>Azure Pack</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.microsoft.com/en-us/server-cloud/products/windows-azure-pack/default.aspx). </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureEnvironment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the environment to remove. This parameter is required. This parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the command succeeds and False ($false) if it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the environment to remove. This parameter is required. This parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the command succeeds and False ($false) if it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None or System.Boolean</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>If you use the PassThru parameter, this cmdlet returns a Boolean value. Otherwise, it does not return any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Delete an environment</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\&gt;Remove-AzureEnvironment -Name ContosoEnv </dev:code> <dev:remarks> <maml:para>This command deletes the ContosoEnv environment from Windows PowerShell.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Delete multiple environments</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\&gt;Get-AzureEnvironment | Where-Object EnvironmentName -like "Contoso*" | ForEach-Object {Remove-AzureEnvironment -Name $_.EnvironmentName } </dev:code> <dev:remarks> <maml:para>This command deletes environments whose names begin with "Contoso" from Windows PowerShell.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=397626</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzurePublishSettingsFile</command:name> <maml:description> <maml:para>Downloads the publish-settings file for a Microsoft Azure subscription</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzurePublishSettingsFile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> The Get-AzurePublishSettingsFile cmdlet opens your default browser, logs onto your Microsoft Azure account, and automatically downloads a .publishsettings file that contains information and a certificate for your Microsoft Azure subscription. This file is used by the Import-AzureSubscription cmdlet and is an XML file with a ".publishsettings" extension. </maml:para> <maml:para>Security Note: The file downloaded contains an encoded management certificate that serves as the credentials to administer your Microsoft Azure subscriptions and services. Store this file in a secure location or delete after use.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzurePublishSettingsFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Realm</maml:name> <maml:description> <maml:para>The organization ID to use for federated authentication when displaying the Microsoft Azure Portal</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The Microsoft Azure environment name to be used. Example AzureCloud</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Realm</maml:name> <maml:description> <maml:para>The organization ID to use for federated authentication when displaying the Microsoft Azure Portal</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The Microsoft Azure environment name to be used. Example AzureCloud</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\&gt; Get-AzurePublishSettingsFile </dev:code> <dev:remarks> <maml:para>This example launches your default browser, connects to your Microsoft Azure account, and then automatically downloads the .publishsettings file for your account. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureSubscription</command:name> <maml:description> <maml:para>Gets Azure subscriptions in the user accounts.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureSubscription cmdlet gets the subscriptions in your Azure accounts. You can use this cmdlet to get information about the subscription and to pipe the subscription to other cmdlets.</maml:para> <maml:para>Get-AzureSubscription requires access to your Azure accounts. Before you run Get-AzureSubscription, you must run the Add-AzureAccount cmdlet or the cmdlets that download and install a publish settings file (Get-AzurePublishSettingsFile, Import-AzurePublishSettingsFile.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-AzureSubscription</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="">
          <maml:name>SubscriptionName</maml:name>
          <maml:description>
            <maml:para>Gets only the specified subscription. Enter the subscription name. The value is case-sensitive. Wildcard characters are not supported. By default, Get-AzureSubscription gets all subscriptions in your Azure accounts.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
          <maml:name>ExtendedDetails</maml:name>
          <maml:description>
            <maml:para>Returns quota properties of the subscription, in addition to the standard properties.</maml:para>
          </maml:description>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
          <maml:name>SubscriptionDataFile</maml:name>
          <maml:description>
            <maml:para>Gets a subscription from an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>Get-AzureSubscription</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
          <maml:name>Current</maml:name>
          <maml:description>
            <maml:para>Gets only the current subscription. By default, Get-AzureSubscription gets all subscriptions in your Azure accounts. </maml:para>
            <maml:para>You can designate "current" and "default" subscriptions. The "current subscription" is used by default in the current Windows PowerShell session. The "default subscription" is used by default for all Windows PowerShell sessions. The "current subscription" label lets you specify a subscription to be used by default for the current session without changing the "default subscription" for all other sessions.</maml:para>
            <maml:para>To designate subscriptions as "current" and "default," use the Select-AzureSubscription cmdlet.</maml:para>
          </maml:description>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
          <maml:name>ExtendedDetails</maml:name>
          <maml:description>
            <maml:para>Returns quota properties of the subscription, in addition to the standard properties.</maml:para>
          </maml:description>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
          <maml:name>SubscriptionDataFile</maml:name>
          <maml:description>
            <maml:para>Gets a subscription from an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>Get-AzureSubscription</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
          <maml:name>Default</maml:name>
          <maml:description>
            <maml:para>Gets only the default subscription. By default, Get-AzureSubscription gets all subscriptions in your Azure accounts. </maml:para>
            <maml:para>The "default subscription" is the subscription that is used by default for all Windows PowerShell sessions. To use a different subscription as the default only for the current session, set a subscription to "Current". To designate subscriptions as "current" and "default," use the Select-AzureSubscription cmdlet.</maml:para>
          </maml:description>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
          <maml:name>ExtendedDetails</maml:name>
          <maml:description>
            <maml:para>Returns quota properties of the subscription, in addition to the standard properties.</maml:para>
          </maml:description>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
          <maml:name>SubscriptionDataFile</maml:name>
          <maml:description>
            <maml:para>Gets a subscription from an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
        <maml:name>Current</maml:name>
        <maml:description>
          <maml:para>Gets only the current subscription. By default, Get-AzureSubscription gets all subscriptions in your Azure accounts. </maml:para>
          <maml:para>You can designate "current" and "default" subscriptions. The "current subscription" is used by default in the current Windows PowerShell session. The "default subscription" is used by default for all Windows PowerShell sessions. The "current subscription" label lets you specify a subscription to be used by default for the current session without changing the "default subscription" for all other sessions.</maml:para>
          <maml:para>To designate subscriptions as "current" and "default," use the Select-AzureSubscription cmdlet.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
        <maml:name>Default</maml:name>
        <maml:description>
          <maml:para>Gets only the default subscription. By default, Get-AzureSubscription gets all subscriptions in your Azure accounts. </maml:para>
          <maml:para>The "default subscription" is the subscription that is used by default for all Windows PowerShell sessions. To use a different subscription as the default only for the current session, set a subscription to "Current". To designate subscriptions as "current" and "default," use the Select-AzureSubscription cmdlet.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
        <maml:name>ExtendedDetails</maml:name>
        <maml:description>
          <maml:para>Returns quota properties of the subscription, in addition to the standard properties.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
        <maml:name>SubscriptionDataFile</maml:name>
        <maml:description>
          <maml:para>Gets a subscription from an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="">
        <maml:name>SubscriptionName</maml:name>
        <maml:description>
          <maml:para>Gets only the specified subscription. Enter the subscription name. The value is case-sensitive. Wildcard characters are not supported. By default, Get-AzureSubscription gets all subscriptions in your Azure accounts.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.AzureSubscription</maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>By default, Get-AzureSubscription returns a AzureSubscription object.</maml:para>
        </maml:description>
      </command:returnValue>
      <command:returnValue>
        <dev:type>
          <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.SubscriptionDataExtended</maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>When you use the ExtendedDetails parameter, Get-AzureSubscription returns a SubscriptionDataExtended object.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <command:examples>
      <command:example>
        <maml:title>Example 1: Get all subscriptions</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>
          C:\PS&gt;Get-AzureSubscription
        </dev:code>
        <dev:remarks>
          <maml:para>This command gets all subscriptions that are available to Windows PowerShell.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>Example 2: Get a subscription by name</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>
          C:\PS&gt;Get-AzureSubscription ???SubscriptionName MyProdSubscription
        </dev:code>
        <dev:remarks>
          <maml:para>This command gets only the "MyProdSubsciption" subscription.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>Example 3: Get the default subscription</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>
          C:\PS&gt;(Get-AzureSubscription -Default).SubscriptionName
          ContosoEngineering
        </dev:code>
        <dev:remarks>
          <maml:para>This command gets the name of the default subscription. The command first gets the subscription and then uses the dot method to get the SubscriptionName property of the subscription.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>Example 4: Get the current subscription</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>
          C:\PS&gt;Get-AzureSubscription -Current | Format-List -Property SubscriptionName, Certificate

        </dev:code>
        <dev:remarks>
          <maml:para>This command returns a list with the name and certificate of the current subscription. It uses a Get-AzureSubscription command to get the current subscription. Then it pipes the subscription to a Format-List command that displays the selected properties in a list.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>Example 5: Get quota properties</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>
          C:\PS&gt;Get-AzureSubscription -SubscriptionDataFile "C:\Temp\MySubscriptions.xml" -ExtendedDetails
        </dev:code>
        <dev:remarks>
          <maml:para>This command gets all properties, included quota properties, of the subscriptions in the C:\Temp\MySubscriptions.xml subscription data file. Use the SubscriptionDataFile parameter if you specified an alternate subscription data file when you ran the Add-AzureAccount or Import-PublishSettingsFile cmdlets.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
    </command:examples>
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version:</maml:linkText>
        <maml:uri>http://go.microsoft.com/fwlink/?LinkID=397623</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Add-AzureAccount</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Get-AzurePublishSettingsFile</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Remove-AzureSubscription</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Select-AzureSubscription</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Set-AzureSubscription</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
    </maml:relatedLinks>
    <maml:alertSet>
      <maml:alert>
        <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para>
      </maml:alert>
    </maml:alertSet>
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Import-AzurePublishSettingsFile</command:name>
      <maml:description>
        <maml:para>Imports a publish-settings file with a certificate to connect to your Microsoft Azure account.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>Import</command:verb>
      <command:noun>AzurePublishSettingsFile</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para>The Import-AzurePublishSettingsFile cmdlet imports a .publishsettings file downloaded using the Get-AzurePublishSettingsFile cmdlet. This file contains settings and an encoded certificate that is used to provide management credentials for the Microsoft Azure account. </maml:para>
      <maml:para>Security Note: The file downloaded contains an encoded management certificate that serves as the credentials to administer Microsoft Azure subscriptions and services. Store this file in a secure location or delete after use.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Import-AzurePublishSettingsFile</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="">
          <maml:name>PublishSettingsFile</maml:name>
          <maml:description>
            <maml:para>Specifies the full path and filename for the .publishsettings file for the Microsoft Azure account.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="">
          <maml:name>SubscriptionDataFile</maml:name>
          <maml:description>
            <maml:para>Specifies the path to a file where the subscription data is stored. This parameter is optional. If it is not provided, the subscription data is imported into a default file in the user's profile.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>PublishSettingsFile</maml:name> <maml:description> <maml:para>Specifies the full path and filename for the .publishsettings file for the Microsoft Azure account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies the path to a file where the subscription data is stored. This parameter is optional. If it is not provided, the subscription data is imported into a default file in the user's profile.. </maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>
          </maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>
          </maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>
          </maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>
          </maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <maml:alertSet>
      <maml:title>
      </maml:title>
      <maml:alert>
        <maml:para>node-dev, php-dev</maml:para>
        <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>
          --------------  Example 1 --------------
        </maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>
          PS C:\&gt; Import-AzurePublishSettingsFile –PublishSettingsFile "C:\Temp\MyAccountName-date-credentials.publishsettings"
        </dev:code>
        <dev:remarks>
          <maml:para>This example imports the "C:\Temp\MyAccountName-date-credentials.publishsettings" file for a Microsoft Azure account, including the encoded certificate used for management of the account. </maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>
          --------------  Example 2 --------------
        </maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>
          PS C:\&gt; Import-AzurePublishSettingsFile –PublishSettingsFile "C:\Temp\MyAccountName-date-credentials.publishsettings" –SubscriptionDataFile c:\Subs\Subscriptions.xml" </dev:code> <dev:remarks> <maml:para>This example imports the "C:\Temp\MyAccountName-date-credentials.publishsettings" file for a Microsoft Azure account, including the encoded certificate used for management of the account. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Select-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureSubscription</command:name> <maml:description> <maml:para>Deletes an Azure subscription from Windows PowerShell.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureSubscription cmdlet deletes an Azure subscription from your subscription data file so Windows PowerShell can't find it. This cmdlet does not delete the subscription from Microsoft Azure, or change the actual subscription in any way.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription name. This parameter is required. The parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the confirmation prompt. By default, Remove-AzureSubscription prompts you before deleting the subscription.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the command succeeds and False ($false) if it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Deletes the subscription from an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the confirmation prompt. By default, Remove-AzureSubscription prompts you before deleting the subscription.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the command succeeds and False ($false) if it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Deletes the subscription from an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription name. This parameter is required. The parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None or System.Boolean</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>If you use the PassThru parameter, this cmdlet returns a Boolean value. Otherwise, it does not return any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Delete a subscription</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS&gt; Remove-AzureSubscription -SubscriptionName Test Confirm Are you sure you want to perform this action? [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): </dev:code> <dev:remarks> <maml:para>This command deletes the "Test" subscription from the default subscription data file. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Delete from an alternate subscription data file</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS&gt; Remove-AzureSubscription -SubscriptionName Test -SubscriptionDataFile C:\Subs\MySubscriptions.xml -Force </dev:code> <dev:remarks> <maml:para>This command deletes the Test subscription from the MySubscriptions.xml subscription data file. The command uses the Force parameter to suppress the confirmation prompt.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Delete a subscription in a script</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS&gt; ...if (Remove-AzureSubscription -SubscriptionName Test -PassThru) {...} </dev:code> <dev:remarks> <maml:para>This command uses the Remove-AzureSubscription command in an If statement. It uses the PassThru parameter, which returns a Boolean value, to determine whether the script block in the If statement is executed.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=397627</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Select-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Select-AzureSubscription</command:name> <maml:description> <maml:para>Changes the current and default Azure subscriptions</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Select</command:verb> <command:noun>AzureSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Select-AzureSubscription cmdlet sets and clears the current and default Azure subscriptions.</maml:para> <maml:para>The "current subscription" is the subscription that is used by default in the current Windows PowerShell session. The "default subscription" is used by default in all Windows PowerShell sessions. The "current subscription" label lets you specify a different subscription to be used by default for the current session without changing the "default subscription" for all other sessions.</maml:para> <maml:para>The "default" subscription designation is saved in your subscription data file. The session-specific "current" designation is not saved.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Select-AzureSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription to change. Enter the subscription name. This parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Current</maml:name> <maml:description> <maml:para>Sets the "current" subscription. Use the SubscriptionName parameter to identify the subscription.</maml:para> <maml:para>The "current subscription" is the subscription that is used by default in the current Windows PowerShell session.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) when the operation succeeds and False ($false) when it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Select-AzureSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription to change. Enter the subscription name. This parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) when the operation succeeds and False ($false) when it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Default</maml:name> <maml:description> <maml:para>Sets the "default" subscription. Use the SubscriptionName parameter to identify the subscription.</maml:para> <maml:para>The "default subscription" is the subscription that is used by default in the all Windows PowerShell sessions, unless a different subscription is set to "current".</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Select-AzureSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) when the operation succeeds and False ($false) when it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NoCurrent</maml:name> <maml:description> <maml:para>Clears the "current" subscription setting. When no subscription is set to "current," the Azure PowerShell cmdlets use the default subscription.</maml:para>
          </maml:description>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>Select-AzureSubscription</maml:name>
        <command:parameter required="
false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) when the operation succeeds and False ($false) when it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NoDefault</maml:name> <maml:description> <maml:para>Clears the "default" subscription setting. If there is no "default subscription," the "current subscription" is used by default. When there is no current or default subscription, and you do not identify a subscription, commands that require a subscription fail.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Current</maml:name> <maml:description> <maml:para>Sets the "current" subscription. Use the SubscriptionName parameter to identify the subscription.</maml:para> <maml:para>The "current subscription" is the subscription that is used by default in the current Windows PowerShell session.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Default</maml:name> <maml:description> <maml:para>Sets the "default" subscription. Use the SubscriptionName parameter to identify the subscription.</maml:para> <maml:para>The "default subscription" is the subscription that is used by default in the all Windows PowerShell sessions, unless a different subscription is set to "current".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NoCurrent</maml:name> <maml:description> <maml:para>Clears the "current" subscription setting. When no subscription is set to "current," the Azure PowerShell cmdlets use the default subscription.</maml:para>
        </maml:description>
        <command:parameterValue required="
false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>NoDefault</maml:name> <maml:description> <maml:para>Clears the "default" subscription setting. If there is no "default subscription," the "current subscription" is used by default. When there is no current or default subscription, and you do not identify a subscription, commands that require a subscription fail.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) when the operation succeeds and False ($false) when it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription to change. Enter the subscription name. This parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None or System.Boolean</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>If you use the PassThru parameter, this cmdlet returns a Boolean value. By default, it does not generate any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Set the current subscription</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS&gt; Select-AzureSubscription -SubscriptionName ContosoEngineering -Current </dev:code> <dev:remarks> <maml:para>This command makes "ContosoEngineering" the current subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Set the default description</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS&gt; Select-AzureSubscription -SubscriptionName ContosoFinance -SubscriptionDataFile "C:\subs\MySubscriptions.xml" </dev:code> <dev:remarks> <maml:para>This command changes the default subscription to "ContosoFinance." It saves the setting in the Subscriptions.xml subscription data file.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=397628</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AzureSubscription</command:name> <maml:description> <maml:para>Creates or changes an Azure subscription</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-AzureSubscription cmdlet establishes and changes the properties of an Azure subscription. You can use this cmdlet to create a new subscription or change the properties of an existing subscription.</maml:para> <maml:para>To create a new subscription, select a unique name for the value of the SubscriptionName parameter. To change an existing subscription, use the SubscriptionName parameter to identify the subscription.</maml:para> <maml:para>This cmdlet changes the data in the subscription data file that you create when you use the Add-AzureAccount or Import-AzurePublishSettingsFile cmdlet to add an Azure account to Windows PowerShell.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription name. If an Azure subscription with this name does not exist, this parameter creates a new subscription with the specified name. If the subscription exists, this parameter identifies the subscription and uses the other property values to change it.</maml:para> <maml:para>To get the names of existing Azure subscriptions, use the Get-AzureSubscription cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Specifies a management certificate for the subscription. Management certificates are X.509 certificates that are saved as .cer files and uploaded to the Azure Management Portal. The certificate, including its private key, must be installed on the local computer, either in the current user's personal certificate store, or the local machine???s personal certificate store. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentStorageAccountName</maml:name> <maml:description> <maml:para>Designates the specified storage account as the "current" storage account for the subscription. Enter the storage account name. The parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> <maml:para>This parameter does not create a storage account; it just associates the storage account with the subscription. To create a storage account, use the New-AzureStorageAccount cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the operation succeeds and False ($false) if it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>ResourceManagerEndpoint</maml:name> <maml:description> <maml:para>Sets or changes the endpoint for Azure Resource Manager data to the specified value.</maml:para> <maml:para> For more information about Azure Resource Manager, see <maml:navigationLink><maml:linkText>Azure Resource Manager Cmdlets</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394765) and <maml:navigationLink><maml:linkText>Using Windows PowerShell with Resource Manager</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394767). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>ServiceEndpoint</maml:name> <maml:description> <maml:para>Sets or changes the custom service endpoint for the management service to the specified value.</maml:para> <maml:para>The service endpoint is the Azure management API endpoint in the Azure environment. You can create custom service endpoints and set a different service endpoint for each subscription.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies the path and filename of an alternate subscription data file. This parameter is optional. By default, Set-AzureSubscription gets and changes data in the default subscription data file in your roaming user profile. Use this parameter if you used the SubscriptionDataFile parameter in Add-AzureAccount or Import-AzurePublishSettingsFile to specify an alternate (non-default) location for this file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>Specifies the ID of the subscription. To get the subscription ID of an existing Azure subscription, use the Get-AzureSubscription cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription name. If an Azure subscription with this name does not exist, this parameter creates a new subscription with the specified name. If the subscription exists, this parameter identifies the subscription and uses the other property values to change it.</maml:para> <maml:para>To get the names of existing Azure subscriptions, use the Get-AzureSubscription cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the operation succeeds and False ($false) if it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies the path and filename of an alternate subscription data file. This parameter is optional. By default, Set-AzureSubscription gets and changes data in the default subscription data file in your roaming user profile. Use this parameter if you used the SubscriptionDataFile parameter in Add-AzureAccount or Import-AzurePublishSettingsFile to specify an alternate (non-default) location for this file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Specifies a management certificate for the subscription. Management certificates are X.509 certificates that are saved as .cer files and uploaded to the Azure Management Portal. The certificate, including its private key, must be installed on the local computer, either in the current user's personal certificate store, or the local machine???s personal certificate store. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentStorageAccountName</maml:name> <maml:description> <maml:para>Designates the specified storage account as the "current" storage account for the subscription. Enter the storage account name. The parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> <maml:para>This parameter does not create a storage account; it just associates the storage account with the subscription. To create a storage account, use the New-AzureStorageAccount cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the operation succeeds and False ($false) if it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>ResourceManagerEndpoint</maml:name> <maml:description> <maml:para>Sets or changes the endpoint for Azure Resource Manager data to the specified value.</maml:para> <maml:para> For more information about Azure Resource Manager, see <maml:navigationLink><maml:linkText>Azure Resource Manager Cmdlets</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394765) and <maml:navigationLink><maml:linkText>Using Windows PowerShell with Resource Manager</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394767). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>ServiceEndpoint</maml:name> <maml:description> <maml:para>Sets or changes the custom service endpoint for the management service to the specified value.</maml:para> <maml:para>The service endpoint is the Azure management API endpoint in the Azure environment. You can create custom service endpoints and set a different service endpoint for each subscription.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies the path and filename of an alternate subscription data file. This parameter is optional. By default, Set-AzureSubscription gets and changes data in the default subscription data file in your roaming user profile. Use this parameter if you used the SubscriptionDataFile parameter in Add-AzureAccount or Import-AzurePublishSettingsFile to specify an alternate (non-default) location for this file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>Specifies the ID of the subscription. To get the subscription ID of an existing Azure subscription, use the Get-AzureSubscription cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription name. If an Azure subscription with this name does not exist, this parameter creates a new subscription with the specified name. If the subscription exists, this parameter identifies the subscription and uses the other property values to change it.</maml:para> <maml:para>To get the names of existing Azure subscriptions, use the Get-AzureSubscription cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None or System.Boolean</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>When you use the PassThru parameter, this cmdlet returns a Boolean value. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a new subscription</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\&gt;$thumbprint = &lt;Certificate Thumbprint&gt; PS C:\&gt;$myCert = Get-Item cert:\\CurrentUser\My\$thumbprint PS C:\&gt;Set-AzureSubscription -SubscriptionName ContosotTest -Certificate $myCert -SubscriptionID 12345 </dev:code> <dev:remarks> <maml:para>These commands create the ContosoTest subscription in the default subscription data file. The commands add a management certificate and subscription ID for the new subscription.</maml:para> <maml:para>When you run the Set-AzureSubscription command, the cmdlet looks for a subscription with the name "ContosoTest". If it doesn't find one, it creates a new subscription with the specified values.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Change an existing subscription</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS&gt; $thumbprint = &lt;Thumbprint-2&gt; C:\PS&gt; $differentCert = Get-Item cert:\\CurrentUser\My\$thumbprint C:\PS&gt; Set-AzureSubscription ???SubscriptionName ContosoEngineering -Certificate $differentCert </dev:code> <dev:remarks> <maml:para>These commands are very similar to the commands in Example 1. However, because the SubscriptionName parameter now identifies an existing subscription, Set-AzureSubscription uses the remaining parameters to change the values of the existing subscription rather than creating a new subscription</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Change the service endpoint</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS&gt; Set-AzureSubscription ???SubscriptionName ContosoEngineering -ServiceEndpoint "https://management.core.contoso.com" </dev:code> <dev:remarks> <maml:para>This command adds or changes a custom service endpoint for the ContosoEngineering subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Clear property values</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS&gt; Set-AzureSubscription ???SubscriptionName ContosoEngineering ???Certificate $null -ResourceManagerEndpoint $null </dev:code> <dev:remarks> <maml:para>This command sets the values of the Certificate and ResourceManagerEndpoint properties to null ($null). This clears the values of those properties without changing other settings.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Use an alternate subscription data file</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS&gt; Set-AzureSubscription -SubscriptionName ContosoFinance -SubscriptionDataFile = C:\Azure\SubscriptionData.xml - CurrentStorageAccount ContosoStorage01 </dev:code> <dev:remarks> <maml:para>This command changes the current storage account of the ContosoFinance subscription to ContosoStorage01. The command uses the SubscriptionDataFile parameter to change the data in the C:\Azure\SubscriptionData.xml subscription data file. By default, Set-AzureSubscription uses the default subscription data file in your roaming user profile.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=397630</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Select-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-AzureCacheWorkerRole</command:name> <maml:description> <maml:para>Add a dedicated cache worker role to the current service</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureCacheWorkerRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Add a dedicated cache worker role to the current service</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureCacheWorkerRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the cache worker role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of worker role instances to devote to the cache worker role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the cache worker role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of worker role instances to devote to the cache worker role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Basic -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzureCacheWorkerRole</dev:code> <dev:remarks> <maml:para>Adds a cache role to the current service</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-AzureMemcacheRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureNodeWebRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzurePHPWebRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-AzureNodeWebRole</command:name> <maml:description> <maml:para>Creates scaffolding for a Node.js application which will be hosted in the cloud via IIS</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureNodeWebRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates scaffolding for a Node.js application which will be hosted in the cloud via IIS</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureNodeWebRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the web role, determines the name of the directory containing the scaffolding for the node.js application that will be hosted in the web role, default is WebRole# Where # is the number of web roles in the service</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this web role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the web role, determines the name of the directory containing the scaffolding for the node.js application that will be hosted in the web role, default is WebRole# Where # is the number of web roles in the service</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>WebRole1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this web role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzureNodeWebRole</dev:code> <dev:remarks> <maml:para>Adds a Microsoft Azure web role with the default configuration (Name = "Webole1", Instances = 1)</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Single Instance Web Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzureNodeWebRole -Name MyWebRole</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a single web role named "MyWebRole" to the current application</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Multiple Instance Web Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzureNodeWebRole MyWebRole -I 2</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new web role named "MyWebRole" to the current application, with a role instance count of 2</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureNodeWorkerRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-AzureNodeWorkerRole</command:name> <maml:description> <maml:para>Creates scaffolding for a Node.js application which will be hosted in the cloud via node.exe</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureNodeWorkerRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates scaffolding for a Node.js application which will be hosted in the cloud via node.exe</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureNodeWorkerRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the worker role, determines the folder name that will contain the scaffolding for the node.js service hosted in the worker role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this worker role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the worker role, determines the folder name that will contain the scaffolding for the node.js service hosted in the worker role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>WorkerRole1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this worker role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzureNodeWorkerRole</dev:code> <dev:remarks> <maml:para>Adds a Microsoft Azure Worker role with the default configuration (Name = "WorkerRole1", Instances = 1)</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Single Instance Worker Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzureNodeWorkerRole MyWorkerRole</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a single worker role named "MyWorkerRole" to the current application</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Multiple Instance Worker Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzureNodeWorkerRole MyWorkerRole -I 2</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new worker role named "MyWorkerRole" to the current application, with a role instance count of 2</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureNodeWebRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-AzurePHPWebRole</command:name> <maml:description> <maml:para>Creates scaffolding for a PHP application which will be hosted in the cloud via IIS</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzurePHPWebRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates scaffolding for a PHP application which will be hosted in the cloud via IIS</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzurePHPWebRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the web role, determines the name of the directory containing the scaffolding for the PHP application that will be hosted in the web role, default is WebRole# Where # is the number of web roles in the service</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this web role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the web role, determines the name of the directory containing the scaffolding for the PHP application that will be hosted in the web role, default is WebRole# Where # is the number of web roles in the service</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>WebRole1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this web role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzurePHPWebRole</dev:code> <dev:remarks> <maml:para>Adds a Microsoft Azure web role with the default configuration (Name = "Webole1", Instances = 1)</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Single Instance Web Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzurePHPWebRole -Name MyWebRole</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a single web role named "MyWebRole" to the current application</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Multiple Instance Web Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzurePHPWebRole MyWebRole -I 2</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new web role named "MyWebRole" to the current application, with a role instance count of 2</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzurePHPWorkerRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-AzurePHPWorkerRole</command:name> <maml:description> <maml:para>Creates scaffolding for a PHP application which will be hosted in the cloud via php.exe</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzurePHPWorkerRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates scaffolding for a PHP application which will be hosted in the cloud via php.exe</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzurePHPWorkerRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the worker role, determines the folder name that will contain the scaffolding for the PHP service hosted in the worker role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this worker role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the worker role, determines the folder name that will contain the scaffolding for the PHP service hosted in the worker role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>WorkerRole1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this worker role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzurePHPWorkerRole</dev:code> <dev:remarks> <maml:para>Adds a Microsoft Azure Worker role with the default configuration (Name = "WorkerRole1", Instances = 1)</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Single Instance Worker Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzurePHPWorkerRole MyWorkerRole</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a single worker role named "MyWorkerRole" to the current application</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Multiple Instance Worker Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzurePHPWorkerRole MyWorkerRole -I 2</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new worker role named "MyWorkerRole" to the current application, with a role instance count of 2</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzurePHPWebRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Disable-AzureServiceProjectRemoteDesktop</command:name> <maml:description> <maml:para>Disables remote desktop access to a hosted service</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>AzureServiceProjectRemoteDesktop</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Disables remote desktop access to a hosted service. You must publish the service using the Publish-AzureServiceProject cmdlet after disabling remote desktop access for the change to take effect.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AzureServiceProjectRemoteDesktop</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-AzureServiceProjectRemoteDesktop</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-AzureServicProjecte</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Enable-AzureMemcacheRole</command:name> <maml:description> <maml:para>Enable memcached for the specified web role, configured to communicate with the specified dedicated cache role</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>AzureMemcacheRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Enable memcached for the specified web role, configured to communicate with the specified dedicated cache role</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AzureMemcacheRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The name of the web role that will use the cache</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>CacheWorkerRoleName</maml:name> <maml:description> <maml:para>The name of the dedicated cache worker role, created with Add-AzureCacheWorkerRole</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>CacheRuntimeVersion</maml:name> <maml:description> <maml:para>The cache runtime version</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The name of the web role that will use the cache</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>CacheWorkerRoleName</maml:name> <maml:description> <maml:para>The name of the dedicated cache worker role, created with Add-AzureCacheWorkerRole</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>CacheRuntimeVersion</maml:name> <maml:description> <maml:para>The cache runtime version</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Enable Caching in web role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Enable-AzureMemcacheRole WebRole1 WorkerRole1</dev:code> <dev:remarks> <maml:para>Enables memcached in web role WebRole1, using dedicated caching role WorkerRole1</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Enable Caching in worker role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Enable-AzureMemcacheRole WorkerRole1 CacheWorkerRole</dev:code> <dev:remarks> <maml:para>Enables memcached in worker role WorkerRole1, using dedicated caching role CacheWorkerRole</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Enable Caching in web role with runtime version specified -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Enable-AzureMemcacheRole WebRole1 WorkerRole1 1.8.0</dev:code> <dev:remarks> <maml:para>Enables memcached with runtime version 1.8.0 in web role WebRole1, using dedicated caching role WorkerRole1</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureCacheWorkerRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureNodeWebRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzurePHPWebRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Enable-AzureServiceProjectRemoteDesktop</command:name> <maml:description> <maml:para>Enables remote desktop access to a hosted service</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>AzureServiceProjectRemoteDesktop</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Enables remote desktop access to a hosted service. You must publish the service using the Publish-AzureServiceProject cmdlet after enabling remote desktop access for the change to take effect.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AzureServiceProjectRemoteDesktop</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>The username credential you will use when connecting to the azure role instance via RDP. The cmdlet will prompt you for a password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>The username credential you will use when connecting to the azure role instance via RDP. The cmdlet will prompt you for a password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-AzureServiceProjectRemoteDesktop</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Get-AzureServiceProjectRoleRuntime</command:name> <maml:description> <maml:para>Get the runtimes available to install in a role</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureServiceProjectRoleRuntime</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Gets the runtimes available to install in a role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureServiceProjectRoleRuntime</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Runtime</maml:name> <maml:description> <maml:para> The name of the runtime. If a runtime specified, only the specific versions of that runtime available to install in your role in Azure will be returned. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Runtime</maml:name> <maml:description> <maml:para> The name of the runtime. If a runtime specified, only the specific versions of that runtime available to install in your role in Azure will be returned. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureNodeWebRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureNodeWorkerRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProjectRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>New-AzureServiceProject</command:name> <maml:description> <maml:para>Creates scaffolding for a new service</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureServiceProject</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates the necessary files and configuration for a new Microsoft Azure service in the current directory</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureServiceProject</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the service - determines the leftmost portion of the hostname for your service (i.e. &lt;Name&gt;.cloudapp.net), and the directory that will contain your service. Must contain only letters, digits, and the dash character (-).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the service - determines the leftmost portion of the hostname for your service (i.e. &lt;Name&gt;.cloudapp.net), and the directory that will contain your service. Must contain only letters, digits, and the dash character (-).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>New-AzureServiceProject "MyService1"</dev:code> <dev:remarks> <maml:para>Create scaffolding for a new Microsoft Azure service named "MyService1" in the current directory.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureNodeWebRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureNodeWorkerRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProjectRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Publish-AzureServiceProject</command:name> <maml:description> <maml:para>Publish the current service to the cloud</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Publish</command:verb> <command:noun>AzureServiceProject</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Publish the current service to the cloud. Publishing configuration (Subscription, StorageAccountName, Location, Slot) can be specified on the command line, or in local settings via the Set-AzureServiceProject commands.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Publish-AzureServiceProject</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name to be used for the service when publishing to the cloud. The name determines the subdomain label in the cloudapp.net subdomain that will be used to address the service when hosted in Azure (that is, &lt;Name&gt;.cloudapp.net). Any name specified while publishing the service will override the name given when creating the service (see the New-AzureServiceProject commandlet).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Package</maml:name> <maml:description> <maml:para>The package file to deploy. Possible value are either a local .cspkg file or a blob uri containing the package. When you use this option, you don't need to specify 'ServiceName' parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>The service configuration file. This value is used together with the 'Package' parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>The Microsoft Azure storage account name to be used while publishing the service to the cloud. This value is not used until the service is published to the cloud. If no storage account name is provided, the storage account specified by the last call to Set-AzureServiceProject will be used. If no storage account was ever specified, a storage account matching the name of the service will be used. If no such storage account exists, the commandlet will attempt to create a new one - this may fail if a storage account matching the service name exists in another subscription.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>The region in which the application will be hosted. Possible values are: Anywhere Asia, Anywhere Europe, Anywhere US, East Asia, East US, North Central US, North Europe, South Central US, Southeast Asia, West Europe, West US. If no Location is specified, the location specified in the last call to Set-AzureServiceProject will be used. If no Location was ever specified, the Location will be randomly chosen from 'North Central US' and 'South Central US' locations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The deployment slot to be used for this service. Possible values are 'Staging' and 'Production'. If no slot is specified, the slot provided in the last call to Set-AzureDeploymentSlot will be used. If no slot was ever specified, the 'Production' slot will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Launch</maml:name> <maml:description> <maml:para>If specified, launch a browser window to view the application after it is deployed to Azure</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AffinityGroup</maml:name> <maml:description> <maml:para>The affinity group name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeploymentName</maml:name> <maml:description> <maml:para>The deployment name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name to be used for the service when publishing to the cloud. The name determines the subdomain label in the cloudapp.net subdomain that will be used to address the service when hosted in Azure (that is, &lt;Name&gt;.cloudapp.net). Any name specified while publishing the service will override the name given when creating the service (see the New-AzureServiceProject commandlet).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Package</maml:name> <maml:description> <maml:para>The package file to deploy. Possible value are either a local .cspkg file or a blob uri containing the package. When you use this option, you don't need to specify 'ServiceName' parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>The service configuration file. This value is used together with the 'Package' parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>The Microsoft Azure storage account name to be used while publishing the service to the cloud. This value is not used until the service is published to the cloud. If no storage account name is provided, the storage account specified by the last call to Set-AzureServiceProject will be used. If no storage account was ever specified, a storage account matching the name of the service will be used. If no such storage account exists, the commandlet will attempt to create a new one - this may fail if a storage account matching the service name exists in another subscription.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Value taken from the current service settings or the current publish profile</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>The region in which the application will be hosted. Possible values are: Anywhere Asia, Anywhere Europe, Anywhere US, East Asia, East US, North Central US, North Europe, South Central US, Southeast Asia, West Europe, West US. If no Location is specified, the location specified in the last call to Set-AzureServiceProject will be used. If no Location was ever specified, the Location will be randomly chosen from 'North Central US' and 'South Central US' locations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>value from current service settings</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The deployment slot to be used for this service. Possible values are 'Staging' and 'Production'. If no slot is specified, the slot provided in the last call to Set-AzureDeploymentSlot will be used. If no slot was ever specified, the 'Production' slot will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Value from current service settings</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Launch</maml:name> <maml:description> <maml:para>If specified, launch a browser window to view the application after it is deployed to Azure</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Off</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AffinityGroup</maml:name> <maml:description> <maml:para>The affinity group name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeploymentName</maml:name> <maml:description> <maml:para>The deployment name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Publish-AzureServiceProject</dev:code> <dev:remarks> <maml:para>Publishes the current service, using the current service settings and the current Azure publish profile</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProjectRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Remove-AzureService</command:name> <maml:description> <maml:para>Removes the current hosted service</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureService</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Stops and removes the current hosted service, or the service matching the specified service and subscription name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureService</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the service to be removed. If the command is run from a service directory and no name is specified, uses the current service name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription name that was used to host the service. If no subscription is specified, uses the subscription specified in the last call to Set-AzureDeploymentSubscription. If no subscription was ever specified, uses the first subscription in the current Azure publish profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Remove service without confirmation prompts</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the service to be removed. If the command is run from a service directory and no name is specified, uses the current service name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription name that was used to host the service. If no subscription is specified, uses the subscription specified in the last call to Set-AzureDeploymentSubscription. If no subscription was ever specified, uses the first subscription in the current Azure publish profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Remove service without confirmation prompts</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeleteAll</maml:name> <maml:description> <maml:para>Specify to remove the service and the underlying disk blob(s).</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Publish-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureService</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureService</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Set-AzureServiceProject</command:name> <maml:description> <maml:para>Sets default location, subscription, slot, and storage account for the current service</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureServiceProject</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Sets the deployment location, slot, storage account, and subscription for the current service. These values are used whenever the service is published to the cloud.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureServiceProject</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>The region in which the service will be hosted. This value is used whenever the service is published to the cloud. Possible values are: Anywhere Asia, Anywhere Europe, Anywhere US, East Asia, East US, North Central US, North Europe, South Central US, Southeast Asia, West Europe, West US.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot (production or staging) in which the service will be hosted. This value is used whenever the service is published to the cloud. Possible values are: Production, Staging.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Storage</maml:name> <maml:description> <maml:para>The storage account to be used when uploading the service package to the cloud. If the storage account doesn't exist, it will be created when the service is published to the cloud.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription that will host the service in the cloud. This value is used whenever the service is published to the cloud. You will need to register credentials for this subscription by using the Import-AzurePublishSettingsFile commandlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>The region in which the service will be hosted. This value is used whenever the service is published to the cloud. Possible values are: Anywhere Asia, Anywhere Europe, Anywhere US, East Asia, East US, North Central US, North Europe, South Central US, Southeast Asia, West Europe, West US.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot (production or staging) in which the service will be hosted. This value is used whenever the service is published to the cloud. Possible values are: Production, Staging.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Storage</maml:name> <maml:description> <maml:para>The storage account to be used when uploading the service package to the cloud. If the storage account doesn't exist, it will be created when the service is published to the cloud.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription that will host the service in the cloud. This value is used whenever the service is published to the cloud. You will need to register credentials for this subscription by using the Import-AzurePublishSettingsFile commandlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Basic Settings -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Set-AzureServiceProject -Location "North Central US" -Slot Production -Storage myStorageAccount -Subscription myAzureSubscription</dev:code> <dev:remarks> <maml:para> Sets the deployment location for the service to the North Central US region. Sets the deloyment slot to Production. Sets the storage account ahat will be used to stage the service definition to 'myStorageAccount'. Sets the subscription that will host the service to 'mySubscription'. Whenever the service is published to the cloud, it will be hosted in a data center in the North Central US region, it will update the deployment slot, and it will use the specified subscription and storage account. </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProjectRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Set-AzureServiceProjectRole</command:name> <maml:description> <maml:para>Set the number of instances, vm size or the runtime version of a role</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureServiceProjectRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Sets the number of role instances for the specified role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureServiceProjectRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The name of the web or worker role that is changing</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for the specified web or worker role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureServiceProjectRole</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The name of the web or worker role that is changing</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Runtime</maml:name> <maml:description> <maml:para>The runtime to add to the specified role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>The runtime version to add to the specified role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureServiceProjectRole</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The name of the web or worker role that is changing</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>VMSize</maml:name> <maml:description> <maml:para>The vm size of the role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The name of the web or worker role that is changing</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for the specified web or worker role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>VMSize</maml:name> <maml:description> <maml:para>The vm size of the role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Runtime</maml:name> <maml:description> <maml:para>The runtime to add to the specified role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>The runtime version to add to the specified role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Web Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Set-AzureServiceProjectRole "MyWebRole" 2</dev:code> <dev:remarks> <maml:para>Sets the number of instances for the web role named 'MyWebRole1' to 2</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Worker Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Set-AzureServiceProjectRole "MyWorkerRole1" 2</dev:code> <dev:remarks> <maml:para>Sets the role instance count for the worker role named "WorkerRole1" to 2</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Add Node Runtime -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Set-AzureServiceProjectRole MyRole1 node 0.6.20</dev:code> <dev:remarks> <maml:para>Sets the node.exe runtime version for role "MyRole1" to 0.6.20.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Change Web Role VM Size to ExtraLarge-------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Set-AzureServiceProjectRole "MyWebRole" -VMSize ExtraLarge</dev:code> <dev:remarks> <maml:para>Sets VMSize for the web role named 'MyWebRole1' to ExtraLarge</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureNodeWebRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureNodeWorkerRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureServiceProjectRoleRuntime</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Start-AzureEmulator</command:name> <maml:description> <maml:para>Starts both the compute and storage emulators and hosts the current service in the compute emulator</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>AzureEmulator</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Starts both the compute and storage emulators and executes the service</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AzureEmulator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Launch</maml:name> <maml:description> <maml:para>Open a new browser window on the service after hosting it in the emulator</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Emulator mode. Valid values are 'Full' and 'Express'. Default value is 'Express'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Launch</maml:name> <maml:description> <maml:para>Open a new browser window on the service after hosting it in the emulator</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Emulator mode. Valid values are 'Full' and 'Express'. Default value is 'Express'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Express</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Launch --------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\&gt; Start-AzureEmulator -L</dev:code> <dev:remarks> <maml:para>Executes the service in the Azure emulator and launches a new browser window on the emulated service</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-AzureServiceProject</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureEmulator</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Start-AzureService</command:name> <maml:description> <maml:para>Starts the specified hosted service in Azure</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Start</command:verb> <command:noun>AzureService</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Starts the specified hosted service in the cloud, if the service is in the stopped state. Note that the Publish-AzureServiceProject command will attempt to automatically start the service</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AzureService</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the hosted service to start. If no name is specified, starts the current hosted service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The deployment slot (Staging, Production) to start the service in</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription to use when starting the specified service</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the hosted service to start. If no name is specified, starts the current hosted service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The deployment slot (Staging, Production) to start the service in</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription to use when starting the specified service</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Publish-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureService</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureService</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Stop-AzureEmulator</command:name> <maml:description> <maml:para>Stops the compute emulator</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>AzureEmulator</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Stops the Microsoft Azure compute emulator. Any services currently executing in the emulator will be removed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-AzureEmulator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Launch</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Launch</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Start-AzureEmulator</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Stop-AzureService</command:name> <maml:description> <maml:para>Stops the current hosted service</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>AzureService</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Stops the current hosted service in the specified slot in Microsoft Azure. If no slot is specified, stops the service in the Production slot</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-AzureService</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the hosted service to stop. If no name is specified, stops the current hosted service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot where the service is hosted. If no slot is specified, 'Production' is assumed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription to use when stopping the specified service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the hosted service to stop. If no name is specified, stops the current hosted service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot where the service is hosted. If no slot is specified, 'Production' is assumed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription to use when stopping the specified service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-AzureService</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureService</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-AzureName</command:name> <maml:description> <maml:para>Tests whether a Microsoft Azure cloud service name, storage service name or service bus namespace name exists or not.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>AzureName</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>If the name exists, the cmdlet returns $True. If the name does not exist, it returns $False.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-AzureName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Service</maml:name> <maml:description> <maml:para>Specifies to test for an existing cloud service.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service to test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-AzureName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies to test for an existing storage service.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the storage account to test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-AzureName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>ServiceBusNamespace</maml:name> <maml:description> <maml:para>Specifies to test for an existing service bus namespace.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the service bus namespace to test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-AzureName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Website</maml:name> <maml:description> <maml:para>Specifies to test for an existing website.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the service bus namespace to test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the service or storage account to test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Service</maml:name> <maml:description> <maml:para>Specifies to test for an existing service account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies to test for an existing storage account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>ServiceBusNamespace</maml:name> <maml:description> <maml:para>Specifies to test for an existing service bus namespace.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Website</maml:name> <maml:description> <maml:para>Specifies to test for an existing website.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS&gt;Test-AzureName –Service "MyNameService1" </dev:code> <dev:remarks> <maml:para>This command tests to see if the "MyNameService1" is an existing Microsoft Azure cloud service name. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS&gt;Test-AzureName –Storage "mystorename1" </dev:code> <dev:remarks> <maml:para>This command tests to see if the "mystorename1" is an existing Microsoft Azure storage service name. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS&gt;Test-AzureName –ServiceBusNamespace "mynamespace" </dev:code> <dev:remarks> <maml:para>This command tests to see if the "mynamespace" is an existing Microsoft Azure service bus namespace name. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-AzureServiceProjectPackage</command:name> <maml:description> <maml:para>Packages the service project into Microsoft Azure cloud package (*.cspkg).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Save</command:verb> <command:noun>AzureServiceProjectPackage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Packages the service project into Microsoft Azure cloud package (*.cspkg).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-AzureServiceProjectPackage</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS\MyAzureServiceProject&gt;Save-AzureServiceProjectPackage </dev:code> <dev:remarks> <maml:para>This command Creates *.cspgk for MyAzureServiceProject service project.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-AzureWebRole</command:name> <maml:description> <maml:para>Creates scaffolding for a custom web role</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureWebRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates scaffolding for a custom web role</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureWebRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the web role, determines the name of the directory containing the scaffolding for the custom application that will be hosted in the web role, default is WebRole# Where # is the number of web roles in the service</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this web role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>TemplateFolder</maml:name> <maml:description> <maml:para>The web role scaffolding template folder to use</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the web role, determines the name of the directory containing the scaffolding for the custom application that will be hosted in the web role, default is WebRole# Where # is the number of web roles in the service</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>WebRole1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this web role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>TemplateFolder</maml:name> <maml:description> <maml:para>The web role scaffolding template folder to use</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>WebRole1</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzureWebRole</dev:code> <dev:remarks> <maml:para>Adds a Microsoft Azure web role with the default configuration (Name = "Webole1", Instances = 1)</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Single Instance Web Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzureWebRole -Name MyWebRole</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a single web role named "MyWebRole" to the current application</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Multiple Instance Web Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzureWebRole MyWebRole -I 2</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new web role named "MyWebRole" to the current application, with a role instance count of 2</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Create web role with custom scaffolding -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzureWebRole MyWebRole -TemplateFolder .\MyWebTemplateFolder</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new web role named "MyWebRole" to the current application with MyWebTemplateFolder as scaffolding template</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureWorkerRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-AzureWorkerRole</command:name> <maml:description> <maml:para>Creates scaffolding for a custom worker role</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureWorkerRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates scaffolding for a custom worker role</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureWorkerRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the worker role, determines the name of the directory containing the scaffolding for the custom application that will be hosted in the worker role, default is WorkerRole# Where # is the number of Worker roles in the service</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this worker role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>TemplateFolder</maml:name> <maml:description> <maml:para>The scaffolding template folder used to create the worker role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the worker role, determines the name of the directory containing the scaffolding for the custom application that will be hosted in the worker role, default is WorkerRole# Where # is the number of Worker roles in the service</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>WorkerRole1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this worker role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>TemplateFolder</maml:name> <maml:description> <maml:para>The scaffolding template folder used to create the worker role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>WorkerRole1</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzureWorkerRole</dev:code> <dev:remarks> <maml:para>Adds a Microsoft Azure worker role with the default configuration (Name = "Workerole1", Instances = 1)</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Single Instance Worker Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzureWorkerRole -Name MyWorkerRole</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a single worker role named "MyWorkerRole" to the current application</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Multiple Instance Worker Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzureWorkerRole MyWorkerRole -I 2</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new worker role named "MyWorkerRole" to the current application, with a role instance count of 2</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Create worker role with custom scaffolding -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Add-AzureWorkerRole MyWorkerRole -TemplateFoldr .\MyWorkerRoleTemplate</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new worker role named "MyWorkerRole" to the current application, with custom scaffolding .\MyWorkerRoleTemplate</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureWorkerRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>New-AzureRoleTemplate</command:name> <maml:description> <maml:para>Creates azure web and worker role template</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--New copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRoleTemplate</command:noun> <!--New Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates azure web and worker role template</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRoleTemplate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Web</maml:name> <maml:description> <maml:para>Indicates that cmdlet should create web role template folder</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Worker</maml:name> <maml:description> <maml:para>Indicates that cmdlet should create worker role template folder</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Output</maml:name> <maml:description> <maml:para>The output path of generated template</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Web</maml:name> <maml:description> <maml:para>Indicates that cmdlet should create web role template folder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Worker</maml:name> <maml:description> <maml:para>Indicates that cmdlet should create web role template folder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Output</maml:name> <maml:description> <maml:para>The output path of generated template</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.\[Web][Worker]RoleTemplate</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Add web role template -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>New-AzureRoleTemplate -Web</dev:code> <dev:remarks> <maml:para>Create new azure web role template in folder called WebRoleTemplate in the current directory</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Add worker role template -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>New-AzureRoleTemplate -Worker</dev:code> <dev:remarks> <maml:para>Create new azure worker role template in folder called WorkerRoleTemplate in the current directory</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Add Web role template in output folder-------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>New-AzureRoleTemplate -Web -Output C:\MyWebRoleTemplate</dev:code> <dev:remarks> <maml:para>Create new azure web role template in in MyWebRoleTemplate</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureWorkerRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureWebRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Get-AzureSBLocation</command:name> <maml:description> <maml:para>Get the Microsoft Azure regions that may be used to create new Microsoft Azure ServiceBus namespaces</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureSBLocation</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Get the Microsoft Azure regions that may be used to create new Microsoft Azure ServiceBus namespaces</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureSBLocation</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureSBNamespace</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureSBNamespace</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureSBNamespace</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Get-AzureSBNamespace</command:name> <maml:description> <maml:para>Get information about existing Microsoft Azure ServiceBus namespaces</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureSBNamespace</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>List current Microsoft Azure Namespaces or get details about a particular Microsoft Azure ServiceBus namespace</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureSBNamespace</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the ServiceBus namespace</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the ServiceBus namespace</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- List namespaces -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Get-AzureSBNamespace</dev:code> <dev:remarks> <maml:para>List all current Microsoft Azure ServiceBus namespaces</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get ServiceBus namespace detail -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Get-AzureSBNamespace myNamespace</dev:code> <dev:remarks> <maml:para>Get details information about the Microsoft Azure ServiceBus namespace 'myNamespace'</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureSBLocation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureSBNamespace</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureSBNamespace</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>New-AzureSBNamespace</command:name> <maml:description> <maml:para>Create a new Microsoft Azure ServiceBus namespace</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureSBNamespace</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Create a new Microsoft Azure ServiceBus namespace</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureSBNamespace</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the namespace to create</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location to create the namespace in</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>CreateACSNamespace</maml:name> <maml:description> <maml:para>Create assosciated ACS namespace as well</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>NamespaceType</maml:name> <maml:description> <maml:para>Choose if the Namespace will be used for Messaging or Notification Hubs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NamespaceType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the namespace to create</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location to create the namespace in</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>CreateACSNamespace</maml:name> <maml:description> <maml:para>Create assosciated ACS namespace as well</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>NamespaceType</maml:name> <maml:description> <maml:para>Choose if the Namespace will be used for Messaging or Notification Hubs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NamespaceType</command:parameterValue> <dev:type> <maml:name>NamespaceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureSBLocation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureSBNamespace</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureSBNamespace</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Remove-AzureSBNamespace</command:name> <maml:description> <maml:para>Delete a WindowsAzure ServiceBus namespace and all associated objects</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureSBNamespace</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Delete a WindowsAzure ServiceBus namespace and all associated objects</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureSBNamespace</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Microsoft Azure ServiceBus namespace to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Microsoft Azure ServiceBus namespace to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureSBLocation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Azure-SBNamespace</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureSBNamespace</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>New-AzureSBAuthorizationRule</command:name> <maml:description> <maml:para>Creates new Service Bus authorization rule</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureSBAuthorizationRule</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates new Service Bus authorization rule</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureSBAuthorizationRule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Permission</maml:name> <maml:description> <maml:para>The authorization permissions (Send, Manage, Listen)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The entity name to apply rule at.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>PrimaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature primary key. Will be generated if not provided</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>SecondaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature secondary key</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Permission</maml:name> <maml:description> <maml:para>The authorization permissions (Send, Manage, Listen)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The entity name to apply rule at.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>PrimaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature primary key. Will be generated if not provided</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>SecondaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature secondary key</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Creates new authorization rule with generated primary key -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>New-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace -Permission $("Send")</dev:code> <dev:remarks> <maml:para>Creates new authorization rule on namespace level with Send permission</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Creates new authorization rule providing primary key -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>New-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace -Permission $("Manage", "Listen", "Send") -EntityName MyEntity -EntityType Queue -PrimaryKey P+lL/Mnd2Z9sj5hwMrRyAxQDdX8RHfbdqU2eIAqs1rc=</dev:code> <dev:remarks> <maml:para>Creates new authorization rule on MyEntity Queue level with all permissions</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Set-AzureSBAuthorizationRule</command:name> <maml:description> <maml:para>Updates existing Service Bus authorization rule</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureSBAuthorizationRule</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Updates existing Service Bus authorization rule</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureSBAuthorizationRule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Permission</maml:name> <maml:description> <maml:para>The authorization permissions (Send, Manage, Listen)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The entity name to apply rule at.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>PrimaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature primary key. Will be generated if not provided</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>SecondaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature secondary key</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Permission</maml:name> <maml:description> <maml:para>The authorization permissions (Send, Manage, Listen)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The entity name to apply rule at.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>PrimaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature primary key. Will be generated if not provided</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>SecondaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature secondary key</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Renew primary key for authorization rule at namespace level -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Set-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace -Permission $("Send")</dev:code> <dev:remarks> <maml:para>The primary key is renewed</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Update authorization rule permission -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Set-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace -Permission $("Listen", "Send") -EntityName MyEntity -EntityType Queue</dev:code> <dev:remarks> <maml:para>Updates the permissions</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Remove-AzureSBAuthorizationRule</command:name> <maml:description> <maml:para>Removes existing Service Bus authorization rule</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureSBAuthorizationRule</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Removes existing Service Bus authorization rule</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureSBAuthorizationRule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The entity name to apply rule at.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The entity name to apply rule at.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Remove authorization rule at namespace level -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Remove-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace</dev:code> <dev:remarks> <maml:para>Removes authorization rule MyRule from MyNamespace</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Remove authorization rule for a Queue -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Remove-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace -EntityName MyEntity -EntityType Queue</dev:code> <dev:remarks> <maml:para>Removes authorization rule called MyRule for a MyEntity Queue on MyNamespace</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Get-AzureSBAuthorizationRule</command:name> <maml:description> <maml:para>Gets Service bus authorization rules</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureSBAuthorizationRule</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Gets Service bus authorization rules</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureSBAuthorizationRule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the search will be on the namespace level</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The entity name to search for rule at.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Permission</maml:name> <maml:description> <maml:para>The authorization permissions to filter (Send, Manage, Listen). This uses exact match</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureSBAuthorizationRule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the search will be on the namespace level</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Permission</maml:name> <maml:description> <maml:para>The authorization permissions to filter (Send, Manage, Listen). This uses exact match</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The entity name to apply rule at.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Permission</maml:name> <maml:description> <maml:para>The authorization permissions to filter (Send, Manage, Listen). This uses exact match</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Get authorization rule at namespace level -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Get-AzureSBAuthorizationRule -Namespace MyNamespace</dev:code> <dev:remarks> <maml:para>Gets all available authorization rules at MyNamespace</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get authorization rule for a Queue -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Get-AzureSBAuthorizationRule -Namespace MyNamespace -EntityName MyEntity -EntityType Queue</dev:code> <dev:remarks> <maml:para>Gets all available authorization rules a MyEntity Queue on MyNamespace</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get authorization rule by name -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Get-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace</dev:code> <dev:remarks> <maml:para>Gets an authorization rule called MyRule on MyNamespace level</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get authorization rule by permisssion -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Get-AzureSBAuthorizationRule -Namespace MyNamespace -Permission $("Send")</dev:code> <dev:remarks> <maml:para>Gets all authorization rules that have send permission on namespace level</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Get-AzureStoreAddOn</command:name> <maml:description> <maml:para>Gets all the available Microsoft Azure Store Add-Ons for purchasing or the existing add-on instances on the current subscription</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureStoreAddOn</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Gets all the available Microsoft Azure Store Add-Ons for purchasing or the existing add-on instances on the current subscription</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureStoreAddOn</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>If specified, the cmdlet will get available Microsoft Azure Store Add-Ons for purchasing.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Switch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Country</maml:name> <maml:description> <maml:para>If specified, only return the Microsoft Azure Store add-on instances available in that Country. Default is "US"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>If specified, returns the add-on instance that matches this name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>If specified, the cmdlet will return all the available Microsoft Azure Store Add-Ons for purchasing.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Country</maml:name> <maml:description> <maml:para>If specified, only return the Azure Store add-on instances available in that Country. Default is "US"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>If specified, returns the add-on instance that matches this name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Get available Microsoft Azure Store Add-Ons for purchasing -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Get-AzureStoreAddOn -ListAvailable</dev:code> <dev:remarks> <maml:para>Get all the available Microsoft Azure Store Add-Ons for purchasing in US</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get available Microsoft Azure Store Add-Ons in CH -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Get-AzureStoreAddOn -ListAvailable -Country CH</dev:code> <dev:remarks> <maml:para>Get all the available Microsoft Azure Store Add-Ons for purchasing in CH</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get all purchased add-on instances on current subscription -------------- </maml:title> <maml:introduction> <maml:para>C:\PS&gt;</maml:para> C:\PS&gt; </maml:introduction> <dev:code>Get-AzureStoreAddOn</dev:code> <dev:remarks> <maml:para>Get all the purchased add-on instances on the current subscription</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para>